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 |
| Document Processing | service-type-document-processing |
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 |
|---|
| 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 |
| Nursing | service-subcat-nursing |
Hierarchy
The following tree shows how types, categories, and subcategories relate to each other.
Screening (30bc2c03-c8dd-409a-8da6-e0070ea6a681)
|-- Criminal Check (service-cat-criminal)
|-- Motor Vehicle Record Check (service-cat-mvr)
|-- Verification (service-cat-verification)
|-- Identity Verification (service-cat-idv)
|-- Professional License (service-cat-pro-lic)
|-- Nursing (service-subcat-nursing)
|-- Professional Certificate (service-cat-pro-cert)
|-- Nursing (service-subcat-nursing)
|-- Occupational Health Screening (service-cat-ohs)
|-- Drug Screening (service-subcat-drug)
|-- Physical (service-subcat-physical)
|-- TB (service-subcat-tb)
|-- Titer (service-subcat-titer)
|-- Vaccination (service-subcat-vacc)
Identity (service-type-idv)
|-- Identity Verification (service-cat-idv)
Legal (a3b74b1b-b665-40be-bad2-2a49c801cf3f)
Payment (service-type-payment)
Shipment (service-type-shipment)
Document Processing (service-type-document-processing)
Only the Screening and Identity types use categories and subcategories. The remaining types (Legal, Payment, Shipment, Document Processing) do not currently have categories.
The Identity Verification category appears under both the Screening and Identity types.
SSN-based checks (SSN Trace, SSN Verification) use the Screening type, while biometric identity
checks (Identity Verification, Identity & Liveness) use the Identity type.