{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/karmacheck/json-schema/karmacheck-case-data-schema.json", "title": "CaseData", "x-generated": "2026-11-09", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/karmacheck-cases-api-openapi.yml#/components/schemas/CaseData", "type": "object", "required": [ "id", "description", "caseId", "serviceId", "serviceName", "serviceTypeId", "serviceTypeName", "statusId", "status", "statusDisplayName", "crStamp", "modStamp", "groupProfileId", "candidateId", "storageId", "details" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the case data; elsewhere referred to as a `caseDataId`.", "format": "uuid" }, "description": { "type": "string", "description": "The description associated with the `serviceId` of this case data record. A possible value is the name of the service." }, "caseId": { "type": "string", "format": "uuid" }, "serviceId": { "type": "string", "description": "The unique identifier of the service that the case data represents. See [Service](docs/reference/service.md) for a list of possible values." }, "serviceName": { "description": "The name of the service. See [Service](docs/reference/service.md) for a list of supported services.", "type": "string" }, "serviceTypeId": { "$ref": "#/$defs/ServiceTypeId" }, "serviceTypeName": { "$ref": "#/$defs/ServiceTypeName" }, "statusId": { "$ref": "#/$defs/CaseDataStatusID" }, "status": { "$ref": "#/$defs/CaseDataStatus" }, "statusDisplayName": { "type": "string" }, "crStamp": { "type": "string", "format": "date-time" }, "modStamp": { "type": "string", "format": "date-time" }, "groupProfileId": { "type": "string", "format": "uuid" }, "candidateId": { "type": "string", "format": "uuid" }, "storageId": { "type": "string", "description": "The unique identifier of the database record containing the `details` property.", "format": "uuid" }, "details": { "type": "string", "description": "The string representation of `detailsObject`." }, "detailsObject": { "oneOf": [ { "$ref": "#/$defs/DetailsNationalCriminal" }, { "$ref": "#/$defs/DetailsFederalCriminal" }, { "$ref": "#/$defs/DetailsCountyCriminal" }, { "$ref": "#/$defs/DetailsStateCriminalCourt" }, { "$ref": "#/$defs/DetailsStateCriminalDatabase" }, { "$ref": "#/$defs/DetailsDrug" }, { "$ref": "#/$defs/DetailsOHS" }, { "$ref": "#/$defs/DetailsEducation" }, { "$ref": "#/$defs/DetailsEmployment" }, { "$ref": "#/$defs/DetailsMotorVehicle" }, { "$ref": "#/$defs/DetailsSSN" }, { "$ref": "#/$defs/DetailsSexOffender" }, { "$ref": "#/$defs/DetailsGlobalWatchlist" }, { "$ref": "#/$defs/DetailsFACIS" }, { "$ref": "#/$defs/DetailsIdentity" }, { "$ref": "#/$defs/DetailsCPLC" }, { "$ref": "#/$defs/DetailsOIG" }, { "$ref": "#/$defs/DetailsOtherService" }, { "$ref": "#/$defs/DetailsInternational" }, { "$ref": "#/$defs/DetailsLegal" }, { "$ref": "#/$defs/DetailsPayment" }, { "$ref": "#/$defs/DetailsMaskShipment" } ], "description": "Details of the case data. The properties vary based on the type of service." }, "serviceCategory": { "$ref": "#/$defs/ServiceCategory" }, "serviceCategoryId": { "$ref": "#/$defs/ServiceCategoryId" }, "serviceSubCategory": { "$ref": "#/$defs/ServiceSubCategory", "type": "string" }, "serviceSubCategoryId": { "$ref": "#/$defs/ServiceSubCategoryId", "type": "string" }, "pendingStatus": { "$ref": "#/$defs/CaseDataPendingStatus", "type": "string" }, "pendingStatusId": { "$ref": "#/$defs/CaseDataPendingStatusID", "type": "string" }, "locked": { "type": "boolean" } }, "$defs": { "AnalyteDetails": { "title": "AnalyteDetails", "type": "object", "properties": { "resultId": { "type": "string", "description": "The ID of the analyte result." }, "result": { "type": "string", "enum": [ "Positive", "Negative", "Withheld", "Retest Recommended" ], "description": "The analyte result." }, "panelId": { "type": "string", "description": "The service provider's ID for the drug panel." }, "analyteId": { "$ref": "#/$defs/AnalyteID" }, "analyte": { "$ref": "#/$defs/AnalyteName" }, "specimenType": { "type": "string", "enum": [ "Urine", "Breath" ] }, "screeningCutoffValue": { "type": "string", "description": "The numeric value of the cutoff concentration for the screening test." }, "screeningCutoffUnit": { "type": "string", "description": "The unit of measurement associated with the screening cutoff value." }, "confirmationCutoffValue": { "type": "string", "description": "The numeric value of the cutoff concentration for the confirmation test." }, "confirmationCutoffUnit": { "type": "string", "description": "The unit of measurement associated with the confirmation cutoff value." }, "quantity": { "type": "string", "description": "The numeric value of the detected concentration." } } }, "AnalyteID": { "title": "AnalyteID", "type": "string", "enum": [ "6-monoacetylmorphine", "amphetamine", "amphetamines", "amphetamines-amp", "amphetamines-met", "anabolic-steroids", "antidepressants", "barbiturates", "benzodiazepines", "buprenorphine", "butorphanol", "carisoprodol", "chromate", "cocaine", "cotinine", "ethanol-breath", "ethanol-urine", "fentanyl", "hydrocodone", "hydrocodone-hydromorphone", "ketamine", "marijuana", "mdma-mda", "meperidine", "meprobamates", "methadone", "methamphetamine", "methamphetamines", "methaqualone", "nalbuphine", "naltrexone", "nicotine", "opiates", "oxycodone", "oxycodone-oxymorphone", "oxymorphone", "pcp", "pentazocine", "propoxyphene", "specific-gravity", "stimulants", "synthetic-cannabionids", "synthetic-opiates", "tramadol", "tricyclics", "zolpidem-ambien" ], "description": "The unique ID of an analyte." }, "AnalyteName": { "title": "AnalyteName", "type": "string", "enum": [ "6-Monoacetylmorphine", "Amphetamine", "Amphetamines", "Amphetamines (AMP)", "Amphetamines (MET)", "Anabolic Steroids", "Antidepressants", "Barbiturates", "Benzodiazepines", "Buprenorphine", "Butorphanol", "Carisoprodol", "Chromate", "Cocaine", "Cotinine", "Ethanol Breath", "Ethanol Urine", "Fentanyl", "Hydrocodone", "Hydrocodone/Hydromorphone", "Ketamine", "Marijuana", "MDMA/MDA", "Meperidine", "Meprobamates", "Methadone", "Methamphetamine", "Methamphetamines", "Methaqualone", "Nalbuphine", "Naltrexone", "Nicotine", "Opiates", "Oxycodone", "Oxycodone/Oxymorphone", "Oxymorphone", "PCP", "Pentazocine", "Propoxyphene", "Specific Gravity", "Stimulants", "Synthetic Cannabinoids", "Synthetic Opiates", "Tramadol", "Tricyclics", "Zolpidem (Ambien)" ], "description": "The name of the analyte." }, "CaseDataPendingStatus": { "title": "CaseDataPendingStatus", "type": "string", "enum": [ "Drug Test Appointment Scheduled", "Drug Test Appointment Change", "Drug Test Appointment Canceled", "Drug Test Appointment Requested", "Drug Test Sent to Lab", "Drug Test Received at Lab", "Drug Test In Review", "Drug Test Pending", "Drug Test Expired", "Appointment Scheduled", "Appointment Rescheduled", "Appointment Canceled", "Appointment Requested", "Pending", "Appointment No Show", "Partial Results", "Refusal to Test", "Suspended", "Medical Review", "Not Performed" ] }, "CaseDataPendingStatusID": { "title": "CaseDataPendingStatusID", "type": "string", "enum": [ "drugtest-appointment-scheduled", "drugtest-appointment-change", "drugtest-appointment-canceled", "drugtest-appointment-requested", "drugtest-sent", "drugtest-received", "drugtest-review", "drugtest-pending", "drugtest-expired", "pending-status-scheduled", "pending-status-rescheduled", "pending-status-canceled", "pending-status-requested", "pending-status-pending", "pending-status-no-show", "pending-status-partial", "pending-status-refusal", "pending-status-suspended", "pending-status-medical-review", "pending-status-not-performed" ], "description": "The ID of the pending status for the service. See [Case data statuses](docs/reference/case-data-status.md) for more details." }, "CaseDataStatus": { "title": "CaseDataStatus", "description": "The possible statuses of a case data record (an instance of a service).", "type": "string", "enum": [ "acknowledge", "clear", "consider", "not_found", "canceled", "complete", "pending", "error" ] }, "CaseDataStatusID": { "title": "CaseDataStatusID", "description": "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.\n\n- acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6\n- clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33\n- consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724\n- not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8\n- canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d\n- complete (done without prejudice): case-data-status-complete\n- pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64\n- error (error during processing): case-data-status-error", "type": "string", "enum": [ "1a8490cb-084d-4209-bf2f-d46e41d760d6", "e086eea7-e4b7-4c74-ac04-4c3b51c23a33", "f657c777-c38d-489b-ac26-dd9bf0a88724", "96e0420a-4396-4bd1-9b54-447f00eb3ed8", "3d726502-d2e2-4d10-859b-8a218f22086d", "case-data-status-complete", "8f29e0de-10f2-4c84-8379-16c6eb7cdf64", "case-data-status-error" ] }, "CaseOrderDataShipment": { "title": "CaseOrderDataShipment", "type": "object", "description": "The candidate data when `caseOrderDataTypeId` is `codt-shipment`.", "required": [ "recipientName", "address1", "addressType", "city", "state", "postalCode", "shippingMethod", "maskType" ], "properties": { "recipientName": { "type": "string", "description": "The recipient name." }, "address1": { "type": "string", "description": "The recipient's street address." }, "address2": { "type": "string", "description": "The recipient's street address, continued." }, "addressType": { "enum": [ "home", "clinic" ], "description": "The address type." }, "addressSource": { "enum": [ "homeAddress", "newAddress" ], "description": "The source of the address, which indicates whether the address is the same as the candidate's home address. This is used only when `addressType` is `home`." }, "city": { "type": "string", "description": "The recipient's city." }, "state": { "type": "string", "description": "The two-letter state code." }, "postalCode": { "type": "string", "description": "The recipient's zip code." }, "shippingMethod": { "description": "The shipping method.", "enum": [ "2-3 Business Days", "Overnight" ] }, "maskType": { "type": "string", "description": "The mask SKU from [GET `/shipment/mask/list`](karma-api-openapi.yaml/paths/~1shipment~1mask~1list/get)." } } }, "DetailsCPLC": { "title": "DetailsCPLC", "type": "object", "description": "Details from a Professional License and Certification verification.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "comments": { "type": "string" }, "serviceContext": { "type": "object", "properties": { "cplcId": { "description": "The unique ID of the professional license or certification. See [Professional license and certification](docs/reference/cplc.md) for details about the possible values.", "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string" }, "value": { "type": "string" } } } } } }, "licStatus": { "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "expirationDate": { "type": "string", "format": "date" }, "flagged": { "type": "boolean" }, "additionalInfo": { "type": "string", "description": "Always empty, except for nursys." }, "source": { "type": "string" }, "rawDataType": { "type": "string" }, "rawDataKey": { "type": "string", "description": "The S3 key to the raw data." } } }, "DetailsCountyCriminal": { "type": "object", "description": "Details from a county criminal search.", "title": "DetailsCountyCriminal", "properties": { "jurisdictions": { "type": "array", "description": "Details about each jurisdictional search.", "items": { "type": "object", "properties": { "alias": { "type": "string", "description": "The alias used in the search." }, "jurisdiction": { "type": "string", "description": "The jurisdiction that was searched." }, "records": { "type": "array", "description": "Records found from the jurisdictional search.", "items": { "type": "object", "properties": { "comments": { "type": "string" }, "caseNumber": { "type": "string" }, "jurisdiction": { "type": "string" }, "fileDate": { "type": "string", "format": "date" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "nameOnRecord": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "contextualData": { "type": "string" } } } }, "status": { "$ref": "#/$defs/CaseDataStatusID", "description": "The status ID of the jurisdictional search.\n\n- acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6\n- clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33\n- consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 \n- not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8\n- canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d\n- complete (done without prejudice): case-data-status-complete\n- pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64\n- error (error during processing): case-data-status-error" }, "modifiedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "description": "The date and time that the service was ordered.", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" } } } }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "source": { "type": "string" }, "rawDataType": { "type": "string" }, "rawDataKey": { "type": "string" }, "reportHtmlSecureDocumentId": { "type": "string" }, "serviceId": { "type": "string", "enum": [ "fa226cb7-1214-4cdf-9296-6120a7376926" ] }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "description": "Records found from the criminal search.", "items": { "type": "object", "properties": { "comments": { "type": "string" }, "caseNumber": { "type": "string" }, "jurisdiction": { "type": "string" }, "fileDate": { "type": "string", "format": "date" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "nameOnRecord": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "contextualData": { "type": "string" } } } } } }, "DetailsDrug": { "title": "DetailsDrug", "type": "object", "description": "Details from a drug screening.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string", "description": "The service provider's ID for the candidate." }, "scheduledDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time", "description": "The expiration date for the drug test." }, "clientName": { "type": "string", "description": "The name of the company ordering the screening." }, "clientAccount": { "type": "string", "description": "The ordering company's account." }, "clientSubAccount": { "type": "string", "description": "The ordering company's subaccount." }, "clinicId": { "type": "string", "description": "The ID of the clinic." }, "clinicName": { "type": "string", "description": "The name of the clinic that's performing the screening." }, "clinicAddress1": { "type": "string", "description": "The clinic's address." }, "clinicAddress2": { "type": "string", "description": "The clinic's address, continued." }, "clinicCity": { "type": "string", "description": "The clinic's city." }, "clinicState": { "type": "string", "description": "The clinic's state" }, "clinicZip": { "type": "string", "description": "The clinic's zip code." }, "clinicPhoneNumber": { "type": "string", "description": "The clinic's phone number." }, "clinicFaxNumber": { "type": "string", "description": "The clinic's fax number." }, "network": { "type": "string", "description": "The network coverage for the clinic." }, "firstName": { "type": "string", "description": "The candidate's first name." }, "lastName": { "type": "string", "description": "The candidate's last name." }, "status": { "type": "string", "description": "The readable text for the status." }, "chainOfCustody": { "type": "string" }, "collectionDate": { "type": "string", "format": "date-time", "description": "The date the specimen was collected." }, "collectionData": { "type": "object", "properties": { "regulation": { "type": "string", "enum": [ "DOT", "Non DOT" ] }, "specimenType": { "type": "string", "enum": [ "Urine", "Breath" ] }, "dilute": { "type": "string", "enum": [ "Dilute", "Not Dilute" ] }, "analytes": { "$ref": "#/$defs/AnalyteDetails" }, "confirmationNumber": { "type": "string", "description": "The service provider confirmation number." }, "labReceivedDate": { "type": "string", "format": "date-time", "description": "The date the specimen was received at the lab." }, "labReportDate": { "type": "string", "format": "date-time", "description": "The date the specimen results were reported by the lab." }, "verificationDate": { "type": "string", "format": "date-time", "description": "The date the specimen was verified by the lab or medical review officer (MRO)." }, "labName": { "type": "string", "description": "The name of the lab that's analyzing the specimen." }, "collectionSite": { "type": "string", "description": "The collection site location." }, "collectionSiteInNetwork": { "type": "string", "description": "The network coverage for the clinic." }, "collectionSitePhoneNumber": { "type": "string", "description": "The collection site's phone number." }, "eCupCollection": { "type": "string", "enum": [ "Not an eCup Collection", "eCup Collection" ] }, "donorName": { "type": "string", "description": "The candidate's full name, last name followed by first name." }, "dob": { "type": "string", "description": "The candidate's date of birth." }, "ssnLast4": { "type": "string", "description": "The last four digits of the candidate's Social Security number." }, "homePhone": { "type": "string", "description": "The candidate's home phone number." }, "homePhoneExt": { "type": "string", "description": "The candidate's home phone extension." }, "workPhone": { "type": "string", "description": "The candidate's work phone number." }, "workPhoneExt": { "type": "string", "description": "The candidate's work phone extension." }, "otherID": { "type": "string", "description": "An alternate form of identification." }, "otherIDType": { "type": "string", "description": "The type of alternate identification." }, "reasonForTest": { "type": "string", "description": "The reason for the test." }, "specimenCollector": { "type": "string", "description": "The name of the specimen collector." }, "locationInfo": { "type": "string", "description": "Information provided by the lab about the location." }, "mroAddress": { "type": "string", "description": "The MRO's address." }, "mroCity": { "type": "string", "description": "The MRO's city." }, "mroName": { "type": "string", "description": "The MRO's name." }, "mroPhone": { "type": "string", "description": "The MRO's phone number." }, "mroState": { "type": "string", "description": "The MRO's state." }, "mroZip": { "type": "string", "description": "The MRO's zip code." } } }, "result": { "type": "string", "enum": [ "positive", "negative", "withheld", "retest recommended" ], "description": "The readable text for the drug screening result." }, "resultCode": { "type": "string", "description": "The service provider's raw result for the drug screening." }, "resultId": { "type": "string", "description": "The unique ID of the result for the drug screening." }, "comments": { "type": "string", "description": "Comments from the drug screening." }, "additionalInfo": { "type": "string" } } }, "DetailsEducation": { "title": "DetailsEducation", "type": "object", "description": "Details from an education verification.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "statusId": { "$ref": "#/$defs/EducationVerificationIndividualRecordStatus" }, "institution": { "type": "string" }, "location": { "type": "string" }, "receivedResults": { "$ref": "#/$defs/EducationEmploymentReceivedResults" }, "applicantProvided": { "type": "object", "properties": { "degree": { "type": "string" }, "major": { "type": "string" }, "gpa": { "type": "string" }, "dateSpan": { "type": "string" }, "comments": { "type": "string" } } }, "institutionProvided": { "type": "object", "properties": { "degree": { "type": "string" }, "major": { "type": "string" }, "gpa": { "type": "string" }, "dateSpan": { "type": "string" }, "comments": { "type": "string" } } }, "testimonyId": { "type": "string", "description": "Associated testimony identifier" }, "searchId": { "type": "string", "description": "Associated case data search identifier" } } } } } }, "DetailsEmployment": { "title": "DetailsEmployment", "type": "object", "description": "Details from an employment verification.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "statusId": { "$ref": "#/$defs/EmploymentVerificationIndividualRecordStatus" }, "employer": { "type": "string" }, "location": { "type": "string" }, "receivedResults": { "$ref": "#/$defs/EducationEmploymentReceivedResults" }, "applicantProvided": { "type": "object", "properties": { "position": { "type": "string" }, "salary": { "type": "string" }, "dateSpan": { "type": "string" }, "additionalInfo": { "type": "string" } } }, "institutionProvided": { "type": "object", "properties": { "position": { "type": "string" }, "salary": { "type": "string" }, "dateSpan": { "type": "string" }, "additionalInfo": { "type": "string" } } }, "testimonyId": { "type": "string", "description": "Associated testimony identifier" }, "searchId": { "type": "string", "description": "Associated case data search identifier" } } } } } }, "DetailsFACIS": { "title": "DetailsFACIS", "type": "object", "description": "Details from a Fraud Abuse Control Information System (FACIS) search.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "sanctionType": { "type": "string" }, "sanctionDate": { "type": "string", "format": "date" }, "specialty": { "type": "string" }, "occupation": { "type": "string" }, "comments": { "type": "string" }, "upin": { "type": "string" }, "contextualData": { "type": "string" } } } } } }, "DetailsFederalCriminal": { "title": "DetailsFederalCriminal", "type": "object", "description": "Details from a federal criminal search.", "properties": { "serviceId": { "type": "string", "enum": [ "ee774b82-a411-4e2b-a38f-c0641bd836e7" ] }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "description": "Records found from the criminal search.", "items": { "type": "object", "properties": { "state": { "type": "string", "description": "Not applicable to federal district searches." }, "county": { "type": "string", "description": "Applicable to federal district searches." }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "caseNumber": { "type": "string" }, "comments": { "type": "string" }, "jurisdiction": { "type": "string" }, "fileDate": { "type": "string", "format": "date" }, "contextualData": { "type": "string" } } } } } }, "DetailsGlobalWatchlist": { "title": "DetailsGlobalWatchlist", "type": "object", "description": "Details from a global watchlist records check.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string" }, "jurisdiction": { "type": "string" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "disposition": { "type": "string" }, "referenceNumber": { "type": "string" }, "comments": { "type": "string" }, "contextualData": { "type": "string" } } } } } }, "DetailsIdentity": { "title": "DetailsIdentity", "type": "object", "description": "Details from an identity verification.", "properties": { "dateCompleted": { "type": "number" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "serviceId": { "type": "string", "enum": [ "service-idv-id", "service-idv-id-liveliness" ] }, "verificationAttempts": { "type": "array", "description": "A list of verification attempts, with the most recent listed first.", "items": { "type": "object", "properties": { "verificationResult": { "type": "string", "enum": [ "not_verified", "passed", "failed", "manual_pass", "manual_fail" ] }, "adjudicationComments": { "type": "string", "description": "Comments regarding a manual verification." }, "idvProviderRefId": { "type": "string" }, "idvProvider": { "type": "string" }, "adjudicator": { "type": "string", "enum": [ "system", "manual" ], "description": "Null if `verificationResult` is `not_verified`." }, "completionStamp": { "type": "number", "description": "Null if `verificationResult` is `not_verified`." }, "images": { "type": "array", "description": "Null if `verificationResult` is `not_verified`.", "items": { "type": "object", "properties": { "imageType": { "type": "string", "enum": [ "drivers_license", "id_thumbnail", "liveliness", "signature" ] }, "secureImageId": { "type": "string", "format": "uuid" } } } } } } } } }, "DetailsInternational": { "title": "DetailsInternational", "type": "object", "description": "Details from international screenings.", "properties": { "externalId": { "type": "string", "format": "uuid", "description": "The service provider's ID for the candidate." }, "source": { "type": "string" }, "dateCompleted": { "type": "string", "format": "date-time", "description": "The date when the service was completed." }, "timeToComplete": { "type": "string", "description": "The amount of time it took to complete the service." }, "additionalInfo": { "type": "string" } } }, "DetailsLegal": { "title": "DetailsLegal", "type": "object", "description": "Details from a legal service.", "properties": { "dateCompleted": { "type": "number" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "uri": { "type": "string" }, "ackData": { "allOf": [ { "type": "object", "properties": { "valid": { "type": "boolean" } } }, { "oneOf": [ { "$ref": "#/$defs/LegalAcknowledgmentSignature" }, { "$ref": "#/$defs/LegalAcknowledgmentDisclosures" }, { "$ref": "#/$defs/LegalAcknowledgmentDisclosure" } ] } ] } } }, "DetailsMaskShipment": { "title": "DetailsMaskShipment", "description": "Details of a mask shipment.", "allOf": [ { "$ref": "#/$defs/CaseOrderDataShipment" }, { "type": "object", "properties": { "trackingNumber": { "type": "string" }, "courier": { "type": "string" }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" } } } ] }, "DetailsMotorVehicle": { "title": "DetailsMotorVehicle", "type": "object", "description": "Details from a motor vehicle records check.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "state": { "type": "string" }, "licenseNumber": { "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "expirationDate": { "type": "string", "format": "date" }, "licenseClass": { "type": "string" }, "classDescription": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "fullName": { "type": "string" }, "restrictions": { "type": "array", "items": { "type": "string" } }, "endorsements": { "type": "array", "items": { "type": "string" } }, "events": { "type": "array", "items": { "type": "object", "properties": { "state": { "type": "string" }, "eventType": { "type": "string", "enum": [ "Violation", "Suspension", "Disqualified" ] }, "description": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "offenseDate": { "type": "string", "format": "date", "description": "If applicable." }, "convictionDate": { "type": "string", "format": "date", "description": "If applicable." }, "clearDate": { "type": "string", "format": "date", "description": "If applicable." }, "disposition": { "type": "string" }, "stateCode": { "type": "string" }, "acd": { "type": "string" }, "avd1": { "type": "string", "description": "If applicable." }, "avd2": { "type": "string", "description": "If applicable." }, "avd3": { "type": "string", "description": "If applicable." }, "location": { "type": "string" }, "commercial": { "type": "boolean" }, "hazMat": { "type": "boolean" } } } }, "contextualData": { "type": "string" } } } }, "hasResults": { "type": "boolean", "description": "True if records were found; false otherwise. This does not indicate good or bad results." } } }, "DetailsNationalCriminal": { "title": "DetailsNationalCriminal", "type": "object", "description": "Details from a national criminal search.", "properties": { "serviceId": { "type": "string", "enum": [ "d8e3dbdb-c2d7-4787-9736-86fffab74da4" ] }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "description": "Records found from the criminal search.", "items": { "type": "object", "properties": { "state": { "type": "string" }, "county": { "type": "string" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "caseNumber": { "type": "string" }, "comments": { "type": "string" }, "contextualData": { "type": "string" } } } } } }, "DetailsOHS": { "title": "DetailsOHS", "type": "object", "description": "Details from an occupational health screening, such as a physical, vaccination, titer, or TB test.", "properties": { "dateCompleted": { "type": "string", "format": "date-time", "description": "The date and time when the service was complete." }, "timeToComplete": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string", "description": "The service provider's ID for the candidate." }, "confirmationNumber": { "type": "string", "description": "The service provider confirmation number. For eScreen services, this is the ePassport ID." }, "scheduledDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time", "description": "The expiration date for the exam." }, "clientName": { "type": "string", "description": "The name of the company ordering the service." }, "clientAccount": { "type": "string", "description": "The ordering company's account." }, "clientSubAccount": { "type": "string", "description": "The ordering company's subaccount." }, "clinicId": { "type": "string", "description": "The ID of the clinic." }, "clinicName": { "type": "string", "description": "The name of the clinic that's performing the screening." }, "clinicAddress1": { "type": "string", "description": "The clinic's address." }, "clinicAddress2": { "type": "string", "description": "The clinic's address, continued." }, "clinicCity": { "type": "string", "description": "The clinic's city." }, "clinicState": { "type": "string", "description": "The clinic's state." }, "clinicZip": { "type": "string", "description": "The clinic's zip code." }, "clinicPhoneNumber": { "type": "string", "description": "The clinic's phone number." }, "clinicFaxNumber": { "type": "string", "description": "The clinic's fax number." }, "network": { "type": "string", "description": "The network coverage for the clinic." }, "firstName": { "type": "string", "description": "The candidate's first name." }, "lastName": { "type": "string", "description": "The candidate's last name." }, "birthDate": { "type": "string", "description": "The candidate's birth date." }, "ssnLast4": { "type": "string", "description": "The last four digits of the candidate's Social Security number." }, "source": { "type": "string" }, "physicalID": { "type": "string", "description": "The service provider's ID for the physical exam." }, "verificationType": { "type": "string", "enum": [ "titer", "physical", "vaccination" ] }, "componentId": { "type": "string", "description": "The service provider's ID for the service." }, "componentDescription": { "type": "string", "description": "The description for the service component." }, "status": { "type": "string", "description": "The readable text for the status." }, "result": { "type": "string", "description": "The readable text for the result." }, "resultId": { "type": "string", "description": "The unique ID of the result for the service." }, "resultCode": { "type": "string", "description": "The service provider's code for the result of the service." }, "resultDate": { "type": "string", "format": "date-time", "description": "The date and time when the service was performed. For example, when the titer blood draw was performed or when actual immunity happened (via testimony)." }, "resultDueToReason": { "type": "string", "description": "The reason for the result. A reason is not always provided." }, "resultExpirationDate": { "type": "string", "description": "The date the certified result expires. An expiration date is not always provided." }, "resultStatusDescription": { "type": "string", "description": "The description for the result." }, "partialReasons": { "type": "array", "description": "Reasons for a Partial status.", "items": { "type": "string" } }, "examDate": { "type": "string", "description": "The date of the exam." }, "followUpDate": { "type": "string", "description": "The follow-up date, if applicable." }, "certExpirationDate": { "type": "string" }, "tbReadDate": { "type": "string", "description": "The date the TB test was read, if available." }, "comments": { "type": "string", "description": "Comments from the exam." }, "clientAddress1": { "type": "string", "description": "The ordering company's street address." }, "clientAddress2": { "type": "string", "description": "The ordering company's street address, continued." }, "clientCity": { "type": "string", "description": "The ordering company's city." }, "clientContact": { "type": "string", "description": "The ordering company's contact." }, "clientState": { "type": "string", "description": "The ordering company's state." }, "clientZip": { "type": "string", "description": "The ordering company's zip code." }, "collectionSitePhoneNumber": { "type": "string", "description": "The collection site's phone number." }, "dlClass": { "type": "string", "description": "The driver's license class." }, "dlNumber": { "type": "string", "description": "The driver's license number." }, "dlStateCode": { "type": "string", "description": "The driver's license state code." }, "cdlFlag": { "type": "string", "description": "A boolean integer: 1 (true) if the driver's license is a commercial driver's license; 0 (false) otherwise." }, "nrcmeNumber": { "type": "string", "description": "The 10-digit National Registry certification number from the DOT." }, "otherID": { "type": "string", "description": "An alternate form of identification." }, "otherIDType": { "type": "string", "description": "The type of alternate identification {id,name,value}." }, "overallStatusDescription": { "type": "string", "description": "The description of the overall status of the physical exam." }, "physicalReasonDescription": { "type": "string", "description": "The description of the reason for the physical exam." }, "additionalInfo": { "type": "string" } } }, "DetailsOIG": { "title": "DetailsOIG", "type": "object", "description": "Details from an Office of Inspector General (OIG) exclusions search.", "properties": { "result": { "type": "string", "enum": [ "no-exclusion-found", "exclusion-found", "no-exclusion-found-ops", "exclusion-found-ops" ] }, "input": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" }, "govtId": { "type": "string" }, "dob": { "type": "string", "format": "date" } } }, "resultsPage": { "type": "object", "properties": { "secureDocumentId": { "type": "string", "format": "uuid" } } }, "nameMatchResults": { "type": "array", "items": { "type": "object", "properties": { "secureDocumentId": { "type": "string" }, "dobMatch": { "type": "boolean" }, "ssnMatch": { "type": "boolean" }, "dobMissing": { "type": "boolean" }, "oigData": { "type": "object", "properties": { "givenName": { "type": "string" }, "middleName": { "type": "string" }, "familyName": { "type": "string" }, "dob": { "type": "string" }, "npi": { "type": "string" }, "upin": { "type": "string" }, "general": { "type": "string" }, "specialty": { "type": "string" }, "street": { "type": "string" }, "address": { "type": "string" }, "exclType": { "type": "string" }, "exclDate": { "type": "string", "format": "date" }, "waiver": { "type": "string" } } } } } }, "dateCompleted": { "type": "number" }, "timeToComplete": { "type": "string" }, "source": { "type": "string" }, "additionalInfo": { "type": "string" } } }, "DetailsOtherService": { "title": "DetailsOtherService", "type": "object", "description": "Details from a state-specific search, Content-Based SSN Verification (CBSV), Death Master File (DMF), county civil court, socia media, or bankruptcy check.", "properties": { "status": { "type": "string" }, "statusId": { "type": "string" }, "pendingStatusId": { "type": "string" }, "additionalInfo": { "type": "string" }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "source": { "type": "string" } } }, "DetailsPayment": { "title": "DetailsPayment", "type": "object", "description": "Details of a payment.", "properties": { "dateCompleted": { "type": "number" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": [ "string", "null" ] }, "orderPrice": { "type": "integer", "description": "The order amount in cents. For example, `2995` is $29.95." }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "paid", "payment_failure", "refunded", "partial_refund" ] }, "records": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "payment", "payment_failure", "refund" ] }, "paymentDate": { "type": "string" }, "amount": { "type": "number" } } } }, "paymentProviderId": { "type": "string" } } }, "DetailsSSN": { "title": "DetailsSSN", "type": "object", "description": "Details from a Social Security number (SSN) trace.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "ssn": { "type": "string", "enum": [ "XXX-XX-XXXX" ] }, "dateFirstReported": { "type": "string" }, "dateLastReported": { "type": "string" }, "nameScore": { "type": "integer" }, "dobMatch": { "type": "boolean" }, "county": { "type": "string" } } } }, "results": { "type": "boolean", "description": "True if records were found; false otherwise. This does not indicate good or bad results." } } }, "DetailsSexOffender": { "title": "DetailsSexOffender", "type": "object", "description": "Details from a sex offender search.", "properties": { "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "items": { "type": "object", "properties": { "charge": { "type": "string" }, "offenseType": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "disposition": { "type": "string" }, "caseNumber": { "type": "string" }, "comments": { "type": "string" }, "contextualData": { "type": "string" } } } } } }, "DetailsStateCriminalCourt": { "title": "DetailsStateCriminalCourt", "type": "object", "description": "Details from a state criminal court search.", "properties": { "serviceId": { "type": "string", "enum": [ "c407f6dd-523e-4627-a4d9-8f52d30ee744" ] }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "jurisdictions": { "type": "array", "description": "Details about each jurisdictional search.", "items": { "type": "object", "properties": { "status": { "$ref": "#/$defs/CaseDataStatusID", "description": "The status ID of the jurisdictional search.\n\n- acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6\n- clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33\n- consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 \n- not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8\n- canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d\n- complete (done without prejudice): case-data-status-complete\n- pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64\n- error (error during processing): case-data-status-error" }, "jurisdiction": { "type": "string" } } } }, "records": { "type": "array", "description": "Records found from the criminal search.", "items": { "type": "object", "properties": { "state": { "type": "string" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "caseNumber": { "type": "string" }, "comments": { "type": "string" }, "jurisdiction": { "type": "string" }, "fileDate": { "type": "string", "format": "date" }, "contextualData": { "type": "string" } } } }, "externalSearchAndHasResults": { "type": "boolean" } } }, "DetailsStateCriminalDatabase": { "title": "DetailsStateCriminalDatabase", "type": "object", "description": "Details from a state criminal search.", "properties": { "serviceId": { "type": "string", "enum": [ "d9381240-6230-40ec-9e11-35703e8041bc" ] }, "dateCompleted": { "type": "string", "format": "date-time" }, "timeToComplete": { "type": "string" }, "additionalInfo": { "type": "string" }, "records": { "type": "array", "description": "Records found from the criminal search.", "items": { "type": "object", "properties": { "state": { "type": "string" }, "charge": { "type": "string" }, "offenseType": { "type": "string" }, "disposition": { "type": "string" }, "dispositionDate": { "type": "string", "format": "date" }, "caseNumber": { "type": "string" }, "comments": { "type": "string" }, "jurisdiction": { "type": "string" }, "fileDate": { "type": "string", "format": "date" }, "contextualData": { "type": "string" } } } } } }, "EducationEmploymentReceivedResults": { "title": "EducationEmploymentReceivedResults", "enum": [ "pending", "yes", "no", "notperformed" ], "readOnly": true, "description": "An indicator of whether data was obtained for the service. This does not indicate good or bad data." }, "EducationVerificationIndividualRecordStatus": { "title": "EducationVerificationIndividualRecordStatus", "description": "The status ID of an individual education record's status in the context of an Education Verification case data record.\n\n- acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6\n- consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 \n- pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64", "type": "string", "enum": [ "1a8490cb-084d-4209-bf2f-d46e41d760d6", "f657c777-c38d-489b-ac26-dd9bf0a88724", "8f29e0de-10f2-4c84-8379-16c6eb7cdf64" ] }, "EmploymentVerificationIndividualRecordStatus": { "title": "EmploymentVerificationIndividualRecordStatus", "description": "The status ID of an individual employment record's status in the context of an Employment Verification case data record.\n\n- acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6\n- consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 \n- pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64", "type": "string", "enum": [ "1a8490cb-084d-4209-bf2f-d46e41d760d6", "f657c777-c38d-489b-ac26-dd9bf0a88724", "8f29e0de-10f2-4c84-8379-16c6eb7cdf64" ] }, "LegalAcknowledgmentDisclosure": { "title": "LegalAcknowledgmentDisclosure", "type": "object", "properties": { "sendReport": { "type": "boolean", "description": "If true, a report notification will be emailed to the candidate when the report is finished.", "default": false }, "signature": { "type": "string", "description": "The name entered into the signature input field on the legal step during candidate onboarding. This value might not be exactly the same as the name that the case was ordered under." } } }, "LegalAcknowledgmentDisclosures": { "title": "LegalAcknowledgmentDisclosures", "type": "object", "required": [ "sendReport", "list" ], "properties": { "sendReport": { "type": "boolean", "description": "If true, a report notification will be emailed to the candidate when the report is finished." }, "list": { "type": "array", "items": { "type": "object", "required": [ "legalType" ], "properties": { "legalType": { "$ref": "#/$defs/LegalType", "description": "The type of legal disclosure. This is the value returned after calling [Request location-specific disclosures](karma-api-openapi.yaml/paths/~1case~1id~1{caseId}~1{disclosureType}~1{language}/post)." }, "signature": { "type": "string", "description": "The value that the candidate entered into the signature input field on the legal step. Required if `legalType` is `general-*` or `custom-*`; not required for other types of legal disclosures." } } } } } }, "LegalAcknowledgmentSignature": { "title": "LegalAcknowledgmentSignature", "type": "object", "required": [ "signatureType", "signature" ], "properties": { "signatureType": { "type": "string", "enum": [ "electronic", "manual" ] }, "signature": { "type": "string", "description": "For candidates who onboarded using KarmaCheck's onboarding experience, the value that the candidate entered into the signature input field on the legal step. This might not be exactly the same as the name that the case was ordered under." } } }, "LegalType": { "title": "LegalType", "type": "string", "enum": [ "general-all-disclosure", "general-ca-disclosure", "state-city-all-disclosure", "custom-ab-disclosure-1", "custom-ab-ca-disclosure-1", "custom-ab-disclosure-2", "custom-ab-ca-disclosure-2", "custom-dynamic-all-disclosure", "custom-dynamic-ca-disclosure" ], "description": "The type of legal disclosure." }, "ServiceCategory": { "title": "ServiceCategory", "type": "string", "description": "The category that a service belongs to.", "enum": [ "Payment", "Identity Verification", "Criminal Check", "Motor Vehicle Record Check", "Verification", "Occupational Health Screening", "Professional License" ] }, "ServiceCategoryId": { "title": "ServiceCategoryId", "type": "string", "description": "The unique ID of the service category.", "enum": [ "service-cat-payment", "service-cat-idv", "service-cat-criminal", "service-cat-mvr", "service-cat-verification", "service-cat-ohs", "service-cat-pro-lic" ] }, "ServiceSubCategory": { "title": "ServiceSubCategory", "type": "string", "description": "The subcategory that a service belongs to.", "enum": [ "Drug Screening", "TB", "Titer", "Vaccination", "Physical" ] }, "ServiceSubCategoryId": { "title": "ServiceSubCategoryId", "type": "string", "description": "The unique ID of the service subcategory.", "enum": [ "service-subcat-drug", "service-subcat-tb", "service-subcat-titer", "service-subcat-vacc", "service-subcat-physical" ] }, "ServiceTypeId": { "title": "ServiceTypeId", "type": "string", "description": "The unique ID of the service type. A service can be one of the following types: screening, legal, payment, identity, or shipment.", "enum": [ "30bc2c03-c8dd-409a-8da6-e0070ea6a681", "a3b74b1b-b665-40be-bad2-2a49c801cf3f", "service-type-payment", "service-type-idv", "service-type-shipment" ] }, "ServiceTypeName": { "title": "ServiceTypeName", "type": "string", "description": "The type of service.", "enum": [ "Screening", "Legal", "Payment", "Identity", "Shipment" ] } } }