KarmaCheck Cases API
The Cases API from KarmaCheck — 22 operation(s) for cases.
KarmaCheck Cases API is one of 9 APIs that KarmaCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Cases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 23 operations across 22 paths, and defines 98 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.
23 operations
22 paths
98 schemas
13 GET8 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
KarmaCheck Cases API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT).
By default, every request must be authenticated.
Paths & Operations 23
Across 22 paths, the API surfaces 23 operations — 13 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Cases 23
POST
/case/id/{caseId}/add/services
Add to order
POST
/case/archive/{caseId}
Archive case
PUT
/case/id/{caseId}/action/beginprocessing
Begin processing case
POST
/case/data/id/{caseDataId}/search/id/{searchId}/cancel
Cancel case data search
POST
/case/create
Create case
GET
/case/id/{caseId}/data/{serviceId}/pdf/download
Download legal doc for case data
GET
/case/id/{caseId}/preadverse/{type}/pdf/download
Download pre-adverse action document
POST
/jurisdiction/find/all
Find jurisdictions
GET
/case/list
Get active cases
GET
/case/list/all
Get all cases
GET
/case/id/{caseId}/services
Get all services for case
GET
/candidate/info/case/id/{caseId}
Get candidate info for case
GET
/config/case/id/{caseId}
Get case configuration
GET
/case/id/{caseId}/data/{serviceTypeId}
Get case data by case ID
GET
/case/id/{caseId}
Get case
POST
/case/id/{caseId}/report/pdf/download/url
Get custom report download URL
GET
/case/id/{caseId}/report/pdf/download/url
Get full report download URL
GET
/case/id/{caseId}/data/{serviceId}/pdf
Get legal doc for case data
GET
/case/id/{caseId}/preadverse/{type}/pdf
Get pre-adverse action document
GET
/case/id/{caseId}/services/{serviceType}
Get services for case
PUT
/case/id/{caseId}/action/place
Place case
POST
/case/id/{caseId}/action/preadverse
Pre-adverse action for case
POST
/case/unarchive/{caseId}
Unarchive case
Schemas 98
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are DetailsOHS (60 properties), CaseSummary (49 properties), DetailsDrug (30 properties), CaseData (24 properties). Each schema is shown below with its type and property counts.
CaseOrderDataCandidateAddress
object
The order data (candidate's current home address) when caseOrderDataTypeId is codt-current-candidate-address.
6 properties
5 required
CaseDataStatus
string
The possible statuses of a case data record (an instance of a service).
DetailsMotorVehicle
object
Details from a motor vehicle records check.
5 properties
DetailsSexOffender
object
Details from a sex offender search.
4 properties
EmploymentVerificationIndividualRecordStatus
string
The status ID of an individual employment record's status in the context of an Employment Verification case data record. - acknowledge (done positive): 1a8490c…
CaseDataPendingStatus
string
CaseOrderDataDrugReasonForTest
object
The reason for the drug test.
1 property
DetailsPayment
object
Details of a payment.
7 properties
AdverseActionStatusID
string
The status ID of an adverse action on a candidate. - Pre-Adverse: bb34dc52-4e3b-4baf-8e0b-b6603f9e2a84 - Dispute: ebbcb8e0-a0e7-43fb-930e-e52db4032d47 - Cancel…
DetailsDrug
object
Details from a drug screening.
30 properties
ConfigTspot
object
The configuration for T-Spot testing.
1 property
1 required
ConfigOhsDrugPassportExpiration
object
The configuration that determines how to handle expired ePassports for OHS and drug screenings.
7 properties
7 required
ConfigValuesDrugPolicy
string
The configuration options for a drug policy.
DetailsEducation
object
Details from an education verification.
4 properties
CaseResult
string
ServiceTypeId
string
The unique ID of the service type. A service can be one of the following types: screening, legal, payment, identity, or shipment.
LegalAcknowledgmentDisclosures
object
2 properties
2 required
ServiceConfigs
object
Services with configuration options.
5 properties
AnalyteID
string
The unique ID of an analyte.
DetailsOHS
object
Details from an occupational health screening, such as a physical, vaccination, titer, or TB test.
60 properties
AnalyteDetails
object
11 properties
CaseOrderDataOHSServiceSubstitutions
object
The order data when caseOrderDataTypeId is codt-ohs-service-substitutions. The substitutionMap is an object where each key is a service ID, and the correspondi…
1 property
LegalAcknowledgmentSignature
object
2 properties
2 required
ServiceCategory
string
The category that a service belongs to.
DetailsNationalCriminal
object
Details from a national criminal search.
5 properties
DetailsMaskShipment
Details of a mask shipment.
CaseOrderDataJurisdictionCounty
object
The candidate data when caseOrderDataTypeId is codt-jurisdiction-county.
2 properties
2 required
ConfigValuesAlias
string
The options for an alias configuration.
DetailsOIG
object
Details from an Office of Inspector General (OIG) exclusions search.
8 properties
ConfigEmpVerification
object
The configuration for employment verification.
1 property
1 required
ConfigDiluteDrug
object
The configuration that determines how to handle dilute samples in drug screenings.
7 properties
7 required
ServiceGroupServicesAll
object
1 property
1 required
CaseSummary
object
49 properties
24 required
ConfigValuesEducationVerification
string
The configuration options for education verification.
ConfigValuesTspot
string
The options for T-Spot substitution.
ServiceCategoryId
string
The unique ID of the service category.
CaseDataPendingStatusID
string
The ID of the pending status for the service. See [Case data statuses](docs/reference/case-data-status.md) for more details.
DetailsEmployment
object
Details from an employment verification.
4 properties
DetailsSSN
object
Details from a Social Security number (SSN) trace.
5 properties
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…
ConfigValuesEmploymentVerification
string
The configuration options for employment verification.
ServiceSubCategory
string
The subcategory that a service belongs to.
CaseResultID
string
The ID of the result for the case. See [Case-level result and statuses](docs/reference/case-status.md) for more details about each possible result. - Open: 8c9…
ConfigValuesQuantiferon
string
The options for Quantiferon substitution.
DetailsCountyCriminal
object
Details from a county criminal search.
10 properties
ConfigLostOrIncompleteOHSDrug
object
The configuration that determines how to handle lost or incomplete samples for OHS and drug screenings.
7 properties
7 required
ServiceSubCategoryId
string
The unique ID of the service subcategory.
JurisdictionCounties
object
Jurisdiction lookup entity.
3 properties
1 required
ConfigEmpIncomeVerification
object
The configuration for employment income verification.
1 property
1 required
OrderConfig
object
Options that describe how to run certain screenings for a case. See [Order configuration](docs/reference/order-configuration.md) for details on all configurati…
6 properties
CaseOrderDataOHSAddress
object
The order data (address for finding nearby clinics) when caseOrderDataTypeId is codt-ohs-scheduling-address.
6 properties
5 required
DetailsGlobalWatchlist
object
Details from a global watchlist records check.
4 properties
CreateCase
object
18 properties
4 required
CaseOrderDataCPLC
object
The candidate data when caseOrderDataTypeId is codt-cplc.
3 properties
2 required
DetailsFederalCriminal
object
Details from a federal criminal search.
5 properties
ConfigAliasName
object
The configuration that determines how to run aliases for criminal screenings.
7 properties
7 required
EducationEmploymentReceivedResults
An indicator of whether data was obtained for the service. This does not indicate good or bad data.
AnalyteName
string
The name of the analyte.
ConfigValuesOhsDrugPassportExpirationPolicy
string
The configuration options for an ePassport expiration policy.
CaseOrderDataDocumentProcessing
object
3 properties
3 required
CaseData
object
24 properties
16 required
CaseOrderDataEducation
object
The candidate data when caseOrderDataTypeId is codt-education. Note: Multiple properties are currently optional, but are strongly recommended to be included in…
17 properties
7 required
LegalType
string
The type of legal disclosure.
ConfigQuantiferon
object
The configuration for Quantiferon testing.
1 property
1 required
CaseOrderDataShipment
object
The candidate data when caseOrderDataTypeId is codt-shipment.
10 properties
8 required
CaseOrderDataGovtID
object
The candidate data when caseOrderDataTypeId is codt-govt-id.
1 property
1 required
Contact
object
Details of a contact.
4 properties
2 required
DetailsIdentity
object
Details from an identity verification.
5 properties
DetailsStateCriminalDatabase
object
Details from a state criminal search.
5 properties
AdverseActionStatusName
string
CaseOrderDataMVR
object
The candidate data when caseOrderDataTypeId is codt-mvr.
5 properties
2 required
CaseOrderDataDOB
object
The candidate data when caseOrderDataTypeId is codt-dob.
1 property
1 required
CaseDataStatusID
string
The status ID of a case data record (an instance of a service). See [Case data statuses](docs/reference/case-data-status.md) for more details. - acknowledge (d…
CaseOrderData
object
The data related to a service. Each service has different metadata properties based on the specified caseOrderDataTypeId. See [Provide order data](docs/guides/…
3 properties
2 required
DetailsFACIS
object
Details from a Fraud Abuse Control Information System (FACIS) search.
4 properties
CaseOrderDataJurisdictionFederal
object
The candidate data when caseOrderDataTypeId is codt-fed-district.
1 property
1 required
CaseSecondaryStatusID
string
The ID for the secondary status of a case. See [Case-level result and statuses](docs/reference/case-status.md) for more details about each possible status. - W…
CaseOrderDataDrugTestingAuthority
object
The regulatory authority under which a DOT drug test is conducted.
1 property
CaseStatus
string
DetailsCPLC
object
Details from a Professional License and Certification verification.
12 properties
CaseOrderDataJurisdictionState
object
The candidate data when caseOrderDataTypeId is codt-jurisdiction-state.
1 property
1 required
DetailsStateCriminalCourt
object
Details from a state criminal court search.
7 properties
JurisdictionsFederalDistrictCourtAndCounty
object
Federal district court and county entity.
5 properties
3 required
LegalAcknowledgmentDisclosure
object
2 properties
CaseOrderDataJurisdiction
object
The candidate data when caseOrderDataTypeId is codt-address.
4 properties
3 required
ConfigEduVerification
object
The configuration for education verification.
1 property
1 required
CaseOrderDataEmployment
object
The candidate data when caseOrderDataTypeId is codt-employment. Note: Multiple properties are currently optional, but are strongly recommended to be included i…
16 properties
10 required
DetailsLegal
object
Details from a legal service.
6 properties
CaseOrderDataAlias
object
The candidate data when caseOrderDataTypeId is codt-alias.
3 properties
2 required
ServiceGroupServicesCase
CaseSecondaryStatus
string
DetailsInternational
object
Details from international screenings.
5 properties
EducationVerificationIndividualRecordStatus
string
The status ID of an individual education record's status in the context of an Education Verification case data record. - acknowledge (done positive): 1a8490cb-…
CaseStatusID
string
The ID for the primary status of a case. See [Case-level result and statuses](docs/reference/case-status.md) for more details about each possible status. - Pen…
DetailsOtherService
object
Details from a state-specific search, Content-Based SSN Verification (CBSV), Death Master File (DMF), county civil court, socia media, or bankruptcy check.
7 properties
Configuration
object
The [configuration](docs/reference/order-configuration.md) for a case or package.
6 properties
InvitationStatus
string
The status of onboarding invitation to a candidate.
ServiceTypeName
string
The type of service.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from KarmaCheck 8
Other APIs KarmaCheck publishes across the network.
KarmaCheck Authentication API
KarmaCheck Candidate onboarding API
KarmaCheck Case API
KarmaCheck Packages API
KarmaCheck Secure documents API
KarmaCheck Services API
KarmaCheck Users API
KarmaCheck Verification Book API
#Cases
Where this information came from
This is an independent, third-party profile of KarmaCheck Cases 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.