Get case data by case ID
curl --request GET \
--url https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "12345678-f4ae-4579-b43d-5ab19c93add0",
"description": "National Criminal Search",
"caseId": "1c233169-fc0c-474e-9311-a35029e6154b",
"storageId": "1234fed4-e9a6-45fc-b280-8df5dac39c37",
"details": "{\n \"source\" : \"TazWorks\",\n \"rawDataType\" : \"xml\",\n \"rawDataKey\" : \"16a2841b-a9c2-4415-b57b-280ea1a6e4f9\",\n \"serviceId\" : \"d8e3dbdb-c2d7-4787-9736-86fffab74da4\",\n \"dateCompleted\" : \"2024-08-07T22:04:44.222+00:00\",\n \"timeToComplete\" : \"instant\",\n \"reportHtmlSecureDocumentId\" : \"fea58286-0283-452a-8151-3796435d0e44\"\n}",
"serviceId": "d8e3dbdb-c2d7-4787-9736-86fffab74da4",
"serviceName": "National Criminal Search",
"serviceTypeId": "30bc2c03-c8dd-409a-8da6-e0070ea6a681",
"serviceTypeName": "Screening",
"statusId": "e086eea7-e4b7-4c74-ac04-4c3b51c23a33",
"status": "clear",
"statusDisplayName": "Clear",
"crStamp": "2024-08-07T22:04:37.000+00:00",
"modStamp": "2024-08-07T22:04:42.000+00:00",
"groupProfileId": "ab1234c5-ac27-4c96-bb22-06ae7e372fd2",
"candidateId": "123d5439-18fe-4f14-b7fb-00eca6aa598f",
"detailsObject": {
"source": "TazWorks",
"rawDataType": "xml",
"rawDataKey": "16a2841b-a9c2-4415-b57b-280ea1a6e4f9",
"serviceId": "d8e3dbdb-c2d7-4787-9736-86fffab74da4",
"dateCompleted": "2024-06-28T16:08:36.222+00:00",
"timeToComplete": "instant",
"reportHtmlSecureDocumentId": "fea58286-0283-452a-8151-3796435d0e44"
},
"serviceCategory": "Criminal Check",
"serviceCategoryId": "service-cat-criminal",
"locked": false
},
{
"id": "66068dd2-2bdb-44c7-97c9-14bd92eeed7c",
"description": "NDOT Physical",
"caseId": "4b473169-fc0c-474e-9311-a35029e6154b",
"storageId": "637807a7-fd66-4ec4-853a-30cfc6a902d2",
"details": "{\"dateCompleted\":\"2024-08-07T22:05:00.000Z\",\"timeToComplete\":\"instant\",\"effectiveDate\":\"2024-08-07T22:05:00.000Z\",\"externalId\":\"tWSAxlkhueHHoWRPUzGU\",\"confirmationNumber\":\"AItWSAxlkhueHHoWRPUzGU\",\"scheduledDate\":\"2024-08-02T22:04:00.000Z\",\"expirationDate\":\"2024-08-09T22:04:00.000Z\",\"clientName\":\"Example Company\",\"clientAccount\":\"629236\",\"clientSubAccount\":\"28\",\"clinicId\":\"9588\",\"clinicName\":\"Test Clinic\",\"clinicAddress1\":\"7500 W 110th Street\",\"clinicAddress2\":\"\",\"clinicCity\":\"Omaha\",\"clinicState\":\"NE\",\"clinicZip\":\"66210\",\"clinicPhoneNumber\":\"800-555-0175\",\"clinicFaxNumber\":\"8005550100\",\"network\":\"Out of Network\",\"firstName\":\"Alex\",\"lastName\":\"Miller\",\"birthDate\":\"06/21/1985\",\"ssnLast4\":\"3333\",\"serviceId\":\"service-ohs-ndotphysical\",\"source\":\"escreen\",\"rawDataType\":\"xml\",\"rawDataKey\":\"escreen-tWSAxlkhueHHoWRPUzGU-ohs-779b7282-11fa-4fc0-826e-9b6d0cac94a2\",\"physicalID\":\"658070\",\"verificationType\":\"physical\",\"componentId\":\"1\",\"componentDescription\":\"Non-DOT Physical\",\"status\":\"Complete\",\"result\":\"Able to work without restrictions/limitations\",\"resultId\":\"ohs-result-22-acknowleged-1\",\"resultCode\":\"22\",\"resultDate\":\"2024-08-07T22:05:00.000Z\",\"resultDueToReason\":\"\",\"resultExpirationDate\":\"\",\"resultStatusDescription\":\"Pass\",\"partialReasons\":[],\"examDate\":\"8/7/2024\",\"followUpDate\":\"\",\"certExpirationDate\":\"\",\"tbReadDate\":\"\",\"comments\":\"Alex Miller is clean\",\"clientAddress1\":\"7878 Guy St\",\"clientCity\":\"Omaha\",\"clientContact\":\"Rosario S.\",\"clientState\":\"NE\",\"clientZip\":\"64086\",\"collectionSitePhoneNumber\":\"800-555-0155\",\"cdlFlag\":\"0\",\"overallStatusDescription\":\"Complete\",\"physicalReasonDescription\":\"Follow Up\",\"additionalInfo\":\"\"}",
"serviceId": "service-ohs-ndotphysical",
"serviceName": "NDOT Physical",
"serviceTypeId": "30bc2c03-c8dd-409a-8da6-e0070ea6a681",
"serviceTypeName": "Screening",
"statusId": "1a8490cb-084d-4209-bf2f-d46e41d760d6",
"status": "acknowledge",
"statusDisplayName": "Clear",
"crStamp": "2024-08-07T22:04:38.000+00:00",
"modStamp": "2024-08-07T22:05:32.000+00:00",
"groupProfileId": "ab1234c5-ac27-4c96-bb22-06ae7e372fd2",
"candidateId": "123d5439-18fe-4f14-b7fb-00eca6aa598f",
"detailsObject": {
"dateCompleted": "2024-08-07T22:05:00.000Z",
"timeToComplete": "instant",
"effectiveDate": "2024-08-07T22:05:00.000Z",
"externalId": "tWSAxlkhueHHoWRPUzGU",
"confirmationNumber": "AItWSAxlkhueHHoWRPUzGU",
"scheduledDate": "2024-08-02T22:04:00.000Z",
"expirationDate": "2024-08-09T22:04:00.000Z",
"clientName": "Example Company",
"clientAccount": "629236",
"clientSubAccount": "28",
"clinicId": "9588",
"clinicName": "Test Clinic",
"clinicAddress1": "7500 W 110th Street",
"clinicAddress2": "",
"clinicCity": "Omaha",
"clinicState": "NE",
"clinicZip": "66210",
"clinicPhoneNumber": "800-555-0175",
"clinicFaxNumber": "8005550100",
"network": "Out of Network",
"firstName": "Alex",
"lastName": "Miller",
"birthDate": "06/21/1985",
"ssnLast4": "3333",
"serviceId": "service-ohs-ndotphysical",
"source": "escreen",
"rawDataType": "xml",
"rawDataKey": "escreen-tWSAxlkhueHHoWRPUzGU-ohs-779b7282-11fa-4fc0-826e-9b6d0cac94a2",
"physicalID": "658070",
"verificationType": "physical",
"componentId": "1",
"componentDescription": "Non-DOT Physical",
"status": "Complete",
"result": "Able to work without restrictions/limitations",
"resultId": "ohs-result-22-acknowleged-1",
"resultCode": "22",
"resultDate": "2024-08-07T22:05:00.000Z",
"resultDueToReason": "",
"resultExpirationDate": "",
"resultStatusDescription": "Pass",
"partialReasons": [],
"examDate": "8/7/2024",
"followUpDate": "",
"certExpirationDate": "",
"tbReadDate": "",
"comments": "Alex Miller is clean",
"clientAddress1": "7878 Guy St",
"clientCity": "Omaha",
"clientContact": "Rosario S.",
"clientState": "NE",
"clientZip": "64086",
"collectionSitePhoneNumber": "800-555-0155800-555-0155",
"cdlFlag": "0",
"overallStatusDescription": "Complete",
"physicalReasonDescription": "Follow Up",
"additionalInfo": ""
},
"serviceCategory": "Occupational Health Screening",
"serviceCategoryId": "service-cat-ohs",
"serviceSubCategory": "Physical",
"serviceSubCategoryId": "service-subcat-physical",
"locked": false
}
]
}Cases
Get case data by case ID
Gets the details associated with services ordered and processed for a case.
GET
/
case
/
id
/
{caseId}
/
data
/
{serviceTypeId}
Get case data by case ID
curl --request GET \
--url https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-stage.karmacheck.io/case/id/{caseId}/data/{serviceTypeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "12345678-f4ae-4579-b43d-5ab19c93add0",
"description": "National Criminal Search",
"caseId": "1c233169-fc0c-474e-9311-a35029e6154b",
"storageId": "1234fed4-e9a6-45fc-b280-8df5dac39c37",
"details": "{\n \"source\" : \"TazWorks\",\n \"rawDataType\" : \"xml\",\n \"rawDataKey\" : \"16a2841b-a9c2-4415-b57b-280ea1a6e4f9\",\n \"serviceId\" : \"d8e3dbdb-c2d7-4787-9736-86fffab74da4\",\n \"dateCompleted\" : \"2024-08-07T22:04:44.222+00:00\",\n \"timeToComplete\" : \"instant\",\n \"reportHtmlSecureDocumentId\" : \"fea58286-0283-452a-8151-3796435d0e44\"\n}",
"serviceId": "d8e3dbdb-c2d7-4787-9736-86fffab74da4",
"serviceName": "National Criminal Search",
"serviceTypeId": "30bc2c03-c8dd-409a-8da6-e0070ea6a681",
"serviceTypeName": "Screening",
"statusId": "e086eea7-e4b7-4c74-ac04-4c3b51c23a33",
"status": "clear",
"statusDisplayName": "Clear",
"crStamp": "2024-08-07T22:04:37.000+00:00",
"modStamp": "2024-08-07T22:04:42.000+00:00",
"groupProfileId": "ab1234c5-ac27-4c96-bb22-06ae7e372fd2",
"candidateId": "123d5439-18fe-4f14-b7fb-00eca6aa598f",
"detailsObject": {
"source": "TazWorks",
"rawDataType": "xml",
"rawDataKey": "16a2841b-a9c2-4415-b57b-280ea1a6e4f9",
"serviceId": "d8e3dbdb-c2d7-4787-9736-86fffab74da4",
"dateCompleted": "2024-06-28T16:08:36.222+00:00",
"timeToComplete": "instant",
"reportHtmlSecureDocumentId": "fea58286-0283-452a-8151-3796435d0e44"
},
"serviceCategory": "Criminal Check",
"serviceCategoryId": "service-cat-criminal",
"locked": false
},
{
"id": "66068dd2-2bdb-44c7-97c9-14bd92eeed7c",
"description": "NDOT Physical",
"caseId": "4b473169-fc0c-474e-9311-a35029e6154b",
"storageId": "637807a7-fd66-4ec4-853a-30cfc6a902d2",
"details": "{\"dateCompleted\":\"2024-08-07T22:05:00.000Z\",\"timeToComplete\":\"instant\",\"effectiveDate\":\"2024-08-07T22:05:00.000Z\",\"externalId\":\"tWSAxlkhueHHoWRPUzGU\",\"confirmationNumber\":\"AItWSAxlkhueHHoWRPUzGU\",\"scheduledDate\":\"2024-08-02T22:04:00.000Z\",\"expirationDate\":\"2024-08-09T22:04:00.000Z\",\"clientName\":\"Example Company\",\"clientAccount\":\"629236\",\"clientSubAccount\":\"28\",\"clinicId\":\"9588\",\"clinicName\":\"Test Clinic\",\"clinicAddress1\":\"7500 W 110th Street\",\"clinicAddress2\":\"\",\"clinicCity\":\"Omaha\",\"clinicState\":\"NE\",\"clinicZip\":\"66210\",\"clinicPhoneNumber\":\"800-555-0175\",\"clinicFaxNumber\":\"8005550100\",\"network\":\"Out of Network\",\"firstName\":\"Alex\",\"lastName\":\"Miller\",\"birthDate\":\"06/21/1985\",\"ssnLast4\":\"3333\",\"serviceId\":\"service-ohs-ndotphysical\",\"source\":\"escreen\",\"rawDataType\":\"xml\",\"rawDataKey\":\"escreen-tWSAxlkhueHHoWRPUzGU-ohs-779b7282-11fa-4fc0-826e-9b6d0cac94a2\",\"physicalID\":\"658070\",\"verificationType\":\"physical\",\"componentId\":\"1\",\"componentDescription\":\"Non-DOT Physical\",\"status\":\"Complete\",\"result\":\"Able to work without restrictions/limitations\",\"resultId\":\"ohs-result-22-acknowleged-1\",\"resultCode\":\"22\",\"resultDate\":\"2024-08-07T22:05:00.000Z\",\"resultDueToReason\":\"\",\"resultExpirationDate\":\"\",\"resultStatusDescription\":\"Pass\",\"partialReasons\":[],\"examDate\":\"8/7/2024\",\"followUpDate\":\"\",\"certExpirationDate\":\"\",\"tbReadDate\":\"\",\"comments\":\"Alex Miller is clean\",\"clientAddress1\":\"7878 Guy St\",\"clientCity\":\"Omaha\",\"clientContact\":\"Rosario S.\",\"clientState\":\"NE\",\"clientZip\":\"64086\",\"collectionSitePhoneNumber\":\"800-555-0155\",\"cdlFlag\":\"0\",\"overallStatusDescription\":\"Complete\",\"physicalReasonDescription\":\"Follow Up\",\"additionalInfo\":\"\"}",
"serviceId": "service-ohs-ndotphysical",
"serviceName": "NDOT Physical",
"serviceTypeId": "30bc2c03-c8dd-409a-8da6-e0070ea6a681",
"serviceTypeName": "Screening",
"statusId": "1a8490cb-084d-4209-bf2f-d46e41d760d6",
"status": "acknowledge",
"statusDisplayName": "Clear",
"crStamp": "2024-08-07T22:04:38.000+00:00",
"modStamp": "2024-08-07T22:05:32.000+00:00",
"groupProfileId": "ab1234c5-ac27-4c96-bb22-06ae7e372fd2",
"candidateId": "123d5439-18fe-4f14-b7fb-00eca6aa598f",
"detailsObject": {
"dateCompleted": "2024-08-07T22:05:00.000Z",
"timeToComplete": "instant",
"effectiveDate": "2024-08-07T22:05:00.000Z",
"externalId": "tWSAxlkhueHHoWRPUzGU",
"confirmationNumber": "AItWSAxlkhueHHoWRPUzGU",
"scheduledDate": "2024-08-02T22:04:00.000Z",
"expirationDate": "2024-08-09T22:04:00.000Z",
"clientName": "Example Company",
"clientAccount": "629236",
"clientSubAccount": "28",
"clinicId": "9588",
"clinicName": "Test Clinic",
"clinicAddress1": "7500 W 110th Street",
"clinicAddress2": "",
"clinicCity": "Omaha",
"clinicState": "NE",
"clinicZip": "66210",
"clinicPhoneNumber": "800-555-0175",
"clinicFaxNumber": "8005550100",
"network": "Out of Network",
"firstName": "Alex",
"lastName": "Miller",
"birthDate": "06/21/1985",
"ssnLast4": "3333",
"serviceId": "service-ohs-ndotphysical",
"source": "escreen",
"rawDataType": "xml",
"rawDataKey": "escreen-tWSAxlkhueHHoWRPUzGU-ohs-779b7282-11fa-4fc0-826e-9b6d0cac94a2",
"physicalID": "658070",
"verificationType": "physical",
"componentId": "1",
"componentDescription": "Non-DOT Physical",
"status": "Complete",
"result": "Able to work without restrictions/limitations",
"resultId": "ohs-result-22-acknowleged-1",
"resultCode": "22",
"resultDate": "2024-08-07T22:05:00.000Z",
"resultDueToReason": "",
"resultExpirationDate": "",
"resultStatusDescription": "Pass",
"partialReasons": [],
"examDate": "8/7/2024",
"followUpDate": "",
"certExpirationDate": "",
"tbReadDate": "",
"comments": "Alex Miller is clean",
"clientAddress1": "7878 Guy St",
"clientCity": "Omaha",
"clientContact": "Rosario S.",
"clientState": "NE",
"clientZip": "64086",
"collectionSitePhoneNumber": "800-555-0155800-555-0155",
"cdlFlag": "0",
"overallStatusDescription": "Complete",
"physicalReasonDescription": "Follow Up",
"additionalInfo": ""
},
"serviceCategory": "Occupational Health Screening",
"serviceCategoryId": "service-cat-ohs",
"serviceSubCategory": "Physical",
"serviceSubCategoryId": "service-subcat-physical",
"locked": false
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the case to retrieve details for.
The ID of the service type [blocked] to retrieve.
Available options:
30bc2c03-c8dd-409a-8da6-e0070ea6a681, a3b74b1b-b665-40be-bad2-2a49c801cf3f, service-type-payment, service-type-idv, service-type-shipment Response
OK
The case data associated with each service for the case. This will be undefined if no case data records exist for the given serviceTypeId.
Show child attributes
Show child attributes
⌘I