How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
KarmaCheck

KarmaCheck Candidate onboarding API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

KarmaCheck Candidate onboarding API is one of 9 APIs that KarmaCheck publishes on the 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.

This API exposes 26 operations across 20 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api-stage.karmacheck.io, https://api.karmacheck.io.

26 operations 20 paths 16 schemas 1 DELETE12 GET11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.karmacheck.io
Authentication
HTTP Bearer
Contact
KarmaCheck
Resource Areas
1

Authentication & Security 1

KarmaCheck Candidate onboarding API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT). By default, every request must be authenticated.

Paths & Operations 26

Across 20 paths, the API surfaces 26 operations — 1 DELETE, 12 GET, 11 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Candidate onboarding 26
POST
/case/id/{caseId}/canadadisclosure/{language}
Acknowledge Canada Disclosure
post-case-id-caseId-canadadisclosure-language 3 params body → 200403404422500
GET
/case/id/{caseId}/canadadisclosure/{language}
Get Canada Disclosure
get-case-id-caseId-canadadisclosure-language 3 params → 200403404422500
POST
/case/id/{caseId}/customdisclosure/{language}
Acknowledge Custom Disclosure
post-case-id-caseId-customdisclosure-language 3 params body → 200403404422500
GET
/case/id/{caseId}/customdisclosure/{language}
Get Custom Disclosure
get-case-id-caseId-customdisclosure-language 3 params → 200403404422500
POST
/case/id/{caseId}/esig/{language}
Acknowledge E-Signature
post-case-id-caseId-esig-language 3 params body → 200403404422500
GET
/case/id/{caseId}/esig/{language}
Get E-Signature
get-case-id-caseId-esig-language 3 params → 200403404422500
POST
/case/id/{caseId}/fcra/{language}
Acknowledge FCRA
post-case-id-caseId-fcra-language 3 params → 200403404422500
GET
/case/id/{caseId}/fcra/{language}
Get FCRA
get-case-id-caseId-fcra-language 3 params → 200403404422500
POST
/case/id/{caseId}/intldisclosure/{language}
Acknowledge International Disclosure
post-case-id-caseId-intldisclosure-language 3 params body → 200403404422500
GET
/case/id/{caseId}/intldisclosure/{language}
Get International Disclosure
get-case-id-caseId-intldisclosure-language 3 params → 200403404422500
PUT
/case/id/{caseId}/{disclosureType}/{language}
Acknowledge location-specific disclosures
put-case-id-caseId-disclosureType-language 4 params body → 200403404422500
POST
/case/id/{caseId}/{disclosureType}/{language}
Request location-specific disclosures
post-case-id-caseId-disclosureType-language 4 params body → 200403404422500
POST
/invitation/candidate/create
Create candidate by proxy for invitation
post-invitation-candidate-create body → 200400403404422500
POST
/testimony/create/case/id/{caseId}
Create testimony for case
post-testimony-create-case-id-caseId 1 param body → 200403422500
DELETE
/testimony/id/{testimonyId}/detach/case/id/{caseId}
Detach testimony from case
delete-testimony-id-testimonyId-detach-case-id-caseId 2 params → 200403404500
GET
/candidate/invitation/token/{invitationToken}
Get candidate for invitation
get-candidate-invitation-token-invitationToken 1 param → 200403422500
GET
/candidate/countries
Get countries
get-candidate-countries → 200403500
GET
/invitation/case/{caseId}
Get invitation for case ID
get-invitation-case-caseId 1 param → 200403404500
GET
/case/id/{caseId}/legal/status/{legalType}
Get legal acknowledgement status
get-case-id-caseId-legal-status-legalType 2 params → 200403404422500
GET
/case/id/{caseId}/candidate/id/{candidateId}/url
Get one-time token link
get-case-id-caseid-candidate-id-candidateId-url 2 params → 200403422500
GET
/candidate/secureimage/id/{secureImageId}
Get secure image by ID
get-candidate-secureimage-id-secureImageId 1 param → 200403404422500
GET
/testimony/case/{caseId}
Get testimony for case
get-testimony-case-caseId 1 param → 200403404500
PUT
/case/id/{caseId}/action/refreshinvite
Refresh invitation for case
put-case-id-caseId-action-refreshinvite 1 param → 200403422500
POST
/case/id/{caseId}/action/resendinvite
Resend case invitation
post-case-id-caseId-action-resendinvite 2 params body → 200403422500
POST
/candidate/id/{candidateId}/update/case/id/{caseId}
Update candidate for case
post-candidate-id-candidateId-update-case-id-caseId 2 params body → 200400403500
POST
/testimony/id/{testimonyId}/update/case/id/{caseId}
Update testimony for case
post-testimony-id-testimonyId-update-case-id-caseId 2 params body → 200403404422500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TestimonyEmployment (19 properties), TestimonyEmploymentCreate (18 properties), TestimonyEducation (17 properties), TestimonyEducationCreate (16 properties). Each schema is shown below with its type and property counts.

TestimonyEducationCreate
object
The testimony details when testimonyTypeId is 19edb27e-5bfd-4c0f-888a-a5130b2f5250. Note: Multiple properties are currently optional, but are strongly recommen…
16 properties 7 required
TestimonyCustomProfessionalLicense
object
5 properties 5 required
InvitationStatusID
string
The status ID of a case invitation. See [Invitation status](docs/reference/invitation-status.md) for more details about each possible status. - pending: 3f5e68…
LegalAcknowledgmentSignature
object
2 properties 2 required
TestimonyEmploymentCreate
object
The testimony details when testimonyTypeId is aa99dc08-0238-4050-9176-bf322e077f71. Note: Multiple properties are currently optional, but are strongly recommen…
18 properties 10 required
TestimonyType
string
The ID of the type of candidate data provided as testimony. - Education: 19edb27e-5bfd-4c0f-888a-a5130b2f5250 - Employment: aa99dc08-0238-4050-9176-bf322e077f7…
Testimony
object
4 properties 1 required
TestimonyEmployment
object
19 properties 11 required
LegalAcknowledgmentDisclosure
object
2 properties
LegalType
string
The type of legal disclosure.
LegalAcknowledgmentDisclosures
object
2 properties 2 required
TestimonyDriversLicense
object
8 properties 3 required
TestimonyContact
object
3 properties
TestimonyAddress
object
9 properties 7 required
TestimonyParentalConsent
object
4 properties 4 required
TestimonyEducation
object
17 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

karmacheck-candidate-onboarding-api-openapi.yml Raw ↑

Other APIs KarmaCheck publishes across the network.

KarmaCheck Authentication API
AE Profile APIs.io
KarmaCheck Case API
AE Profile APIs.io
KarmaCheck Cases API
AE Profile APIs.io
KarmaCheck Packages API
AE Profile APIs.io
KarmaCheck Secure documents API
AE Profile APIs.io
KarmaCheck Services API
AE Profile APIs.io
KarmaCheck Users API
AE Profile APIs.io
KarmaCheck Verification Book API
AE Profile APIs.io
#Candidate onboarding
← Back to K APIs
API Details
ID
karmacheck:karmacheck-candidate-onboarding-api
Base URL
https://api.karmacheck.io
Docs
https://developer.karmacheck.com/background-check-api/overview/introduction
Provider
KarmaCheck
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=karmacheck-candidate-onboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/karmacheck-candidate-onboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of KarmaCheck Candidate onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.