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.
Every KarmaCheck service belongs to a type and a category.
Type
The following table lists the possible types of services. The service type and its ID appear respectively as serviceTypeName and serviceTypeId in the response body of API endpoints like GET /case/id/{caseId}/services/{serviceType}. The ID is also accepted in the path parameter of endpoints like GET /case/id/{caseId}/data/{serviceTypeId}.
| Service type | ID |
|---|
| Screening | 30bc2c03-c8dd-409a-8da6-e0070ea6a681 |
| Legal | a3b74b1b-b665-40be-bad2-2a49c801cf3f |
| Payment | service-type-payment |
| Identity | service-type-idv |
| Shipment | service-type-shipment |
Category
The following table lists the possible categories that a service can belong to. The service category and its ID appear respectively as serviceCategory and serviceCategoryId in the response body of API endpoints like GET /case/id/{caseId}/services/{serviceType}.
| Service category | ID |
|---|
| Payment | service-cat-payment |
| Identity Verification | service-cat-idv |
| Criminal Check | service-cat-criminal |
| Motor Vehicle Record Check | service-cat-mvr |
| Verification | service-cat-verification |
| Occupational Health Screening | service-cat-ohs |
| Professional License | service-cat-pro-lic |
Subcategory
Services under the Occupational Health Screening (OHS) category are further categorized by a subcategory. The following table lists the possible subcategories that an OHS service can belong to. The service subcategory and its ID appear respectively as serviceSubCategory and serviceSubCategoryId in the response body of API endpoints like GET /case/id/{caseId}/services/{serviceType}.
| Service subcategory | ID |
|---|
| Physical | service-subcat-physical |
| Drug Screening | service-subcat-drug |
| TB | service-subcat-tb |
| Titer | service-subcat-titer |
| Vaccination | service-subcat-vacc |
