Skip to main content
GET
/
config
/
case
/
id
/
{caseId}
Get case configuration
curl --request GET \
  --url https://api-stage.karmacheck.io/config/case/id/{caseId} \
  --header 'Authorization: Bearer <token>'
{
  "contacts": [
    {
      "email": "jsmith@example.com",
      "name": "<string>",
      "phone": "<string>"
    }
  ],
  "serviceConfigs": {
    "85307784-1f84-471a-8596-c8ea088c3a62": {
      "verificationMethod": {
        "rawValue": "docs-acceptable",
        "pillLabel": "${value}",
        "valueDescription": "Documents acceptable.",
        "configDescription": "Specifies the verification method used for this service.",
        "valueDisplayLabel": "Documents Acceptable",
        "configDisplayLabel": "Verification Method"
      }
    },
    "9ac65633-b4c4-4062-875c-3556db9d2a08": {
      "verificationMethod": {
        "rawValue": "docs-acceptable",
        "pillLabel": "${value}",
        "valueDescription": "Documents acceptable.",
        "configDescription": "Specifies the verification method used for this service.",
        "valueDisplayLabel": "Documents Acceptable",
        "configDisplayLabel": "Verification Method"
      }
    },
    "service-employment-income": {
      "verificationMethod": {
        "rawValue": "docs-acceptable",
        "pillLabel": "${value}",
        "valueDescription": "Documents acceptable.",
        "configDescription": "Specifies the verification method used for this service.",
        "valueDisplayLabel": "Documents Acceptable",
        "configDisplayLabel": "Verification Method"
      }
    },
    "service-ohs-tb-quantiferon-gold": {
      "substitutionPolicy": {
        "rawValue": "company-default",
        "pillLabel": "${value}",
        "valueDescription": "Refer to company settings.",
        "configDescription": "Specifies if T-Spot can be ordered in place of Quantiferon Gold when Quantiferon Gold is unavailable.",
        "valueDisplayLabel": "Refer To Company Settings",
        "configDisplayLabel": "Substitution Policy"
      }
    },
    "service-ohs-tb-tspot-test": {
      "substitutionPolicy": {
        "rawValue": "company-default",
        "pillLabel": "${value}",
        "valueDescription": "Refer to company settings.",
        "configDescription": "Specifies if Quantiferon Gold can be ordered in place of T-Spot when T-Spot is unavailable.",
        "valueDisplayLabel": "Refer To Company Settings",
        "configDisplayLabel": "Substitution Policy"
      }
    }
  },
  "diluteDrugPolicy": {
    "rawValue": "company-default",
    "appliesTo": {
      "serviceIds": [],
      "serviceCategoryIds": [],
      "serviceSubCategoryIds": [
        "service-subcat-drug"
      ]
    },
    "pillLabel": "${value}",
    "valueDescription": "Refer to company settings.",
    "configDescription": "Specifies next steps when a Drug sample is dilute.",
    "valueDisplayLabel": "Refer To Company Settings",
    "configDisplayLabel": "Dilute Drug Policy"
  },
  "aliasNameConfiguration": {
    "rawValue": "no-alias",
    "appliesTo": {
      "serviceIds": [],
      "serviceCategoryIds": [
        "service-cat-criminal"
      ],
      "serviceSubCategoryIds": []
    },
    "pillLabel": "${value}",
    "valueDescription": "No aliases.",
    "configDescription": "Specifies the method used to select aliases.",
    "valueDisplayLabel": "No Aliases",
    "configDisplayLabel": "Alias Name Configuration"
  },
  "lostOrIncompleteOHSDrugPolicy": {
    "rawValue": "company-default",
    "appliesTo": {
      "serviceIds": [],
      "serviceCategoryIds": [
        "service-cat-ohs"
      ],
      "serviceSubCategoryIds": []
    },
    "pillLabel": "${value}",
    "valueDescription": "Refer to company settings.",
    "configDescription": "Specifies next steps when an OHS/Drug sample is lost or incomplete.",
    "valueDisplayLabel": "Refer To Company Settings",
    "configDisplayLabel": "Lost or Incomplete OHS/Drug Policy"
  },
  "ohsDrugPassportExpirationPolicy": {
    "rawValue": "company-default",
    "appliesTo": {
      "serviceIds": [],
      "serviceCategoryIds": [
        "service-cat-ohs"
      ],
      "serviceSubCategoryIds": []
    },
    "pillLabel": "${value}",
    "valueDescription": "Refer to company settings.",
    "configDescription": "Specifies next steps when an OHS/Drug ePassport expires.",
    "valueDisplayLabel": "Refer To Company Settings",
    "configDisplayLabel": "OHS/Drug Passport Expiration Policy"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

caseId
string
required

The ID of the case for which to retrieve configurations.

Response

The response can include any combination of the objects described below. The structure of the response is determined by:

  • Any points of contact that were added to the case.
  • All screenings from the package that was used to create the case, regardless of whether those screenings were ordered for the case.

The configuration [blocked] for a case or package.

contacts
Contact · object[]

A list of people to contact about the case.

serviceConfigs
ServiceConfigs · object

Services with configuration options.

diluteDrugPolicy
DiluteDrugPolicy · object

The configuration that determines how to handle dilute samples in drug screenings.

aliasNameConfiguration
AliasNameConfiguration · object

The configuration that determines how to run aliases for criminal screenings.

lostOrIncompleteOHSDrugPolicy
LostOrIncompleteOHSDrugPolicy · object

The configuration that determines how to handle lost or incomplete samples for OHS and drug screenings.

ohsDrugPassportExpirationPolicy
OhsDrugPassportExpirationPolicy · object

The configuration that determines how to handle expired ePassports for OHS and drug screenings.