> ## 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. # Get case data by case ID > Gets the details associated with services ordered and processed for a case. ## OpenAPI ````yaml /background-check-api/api-reference/openapi.json get /case/id/{caseId}/data/{serviceTypeId} openapi: 3.1.0 info: title: KarmaCheck API description: >- All requests to the KarmaCheck API require a JSON Web Token (JWT) in the Authorization header. For an overview of the API and its authentication method, refer to the following topics: - [API basics](docs/overview/apis/api-overview.md) - [Authentication](docs/overview/apis/authentication.md) - [Environments](docs/overview/apis/environments.md) - [Status codes and errors](docs/overview/apis/errors.md) version: '1.0' contact: name: KarmaCheck email: customersuccess@karmacheck.com servers: - description: Stage url: https://api-stage.karmacheck.io - description: Prod url: https://api.karmacheck.io security: - JWT: [] tags: - name: Authentication - name: Cases - name: Candidate onboarding - name: Secure documents - name: Packages - name: Services - name: Users - name: Companies - name: Partner integrations paths: /case/id/{caseId}/data/{serviceTypeId}: parameters: - schema: type: string name: caseId in: path description: The ID of the case to retrieve details for. required: true - schema: type: string enum: - 30bc2c03-c8dd-409a-8da6-e0070ea6a681 - a3b74b1b-b665-40be-bad2-2a49c801cf3f - service-type-payment - service-type-idv - service-type-shipment name: serviceTypeId in: path required: true description: >- The ID of the [service type](docs/reference/service-type.md) to retrieve. get: tags: - Cases summary: Get case data by case ID description: >- Gets the details associated with services ordered and processed for a case. operationId: get-case-id-caseid-data-servicetypeid responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array description: >- The case data associated with each service for the case. This will be undefined if no case data records exist for the given `serviceTypeId`. items: $ref: '#/components/schemas/CaseData' examples: Example 1: value: data: - id: 12345678-f4ae-4579-b43d-5ab19c93add0 description: National Criminal Search caseId: 1c233169-fc0c-474e-9311-a35029e6154b storageId: 1234fed4-e9a6-45fc-b280-8df5dac39c37 details: |- { "source" : "TazWorks", "rawDataType" : "xml", "rawDataKey" : "16a2841b-a9c2-4415-b57b-280ea1a6e4f9", "serviceId" : "d8e3dbdb-c2d7-4787-9736-86fffab74da4", "dateCompleted" : "2024-08-07T22:04:44.222+00:00", "timeToComplete" : "instant", "reportHtmlSecureDocumentId" : "fea58286-0283-452a-8151-3796435d0e44" } 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 '403': description: Forbidden '500': description: Internal Server Error components: schemas: CaseData: title: 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: '#/components/schemas/ServiceTypeId' serviceTypeName: $ref: '#/components/schemas/ServiceTypeName' statusId: $ref: '#/components/schemas/CaseDataStatusID' status: $ref: '#/components/schemas/CaseDataStatus' statusDisplayName: type: string crStamp: type: string format: date-time example: '2024-05-17T00:06:45.000+00:00' modStamp: type: string format: date-time example: '2024-06-18T00:07:39.000+00:00' 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: '#/components/schemas/DetailsNationalCriminal' - $ref: '#/components/schemas/DetailsFederalCriminal' - $ref: '#/components/schemas/DetailsCountyCriminal' - $ref: '#/components/schemas/DetailsStateCriminalCourt' - $ref: '#/components/schemas/DetailsStateCriminalDatabase' - $ref: '#/components/schemas/DetailsDrug' - $ref: '#/components/schemas/DetailsOHS' - $ref: '#/components/schemas/DetailsEducation' - $ref: '#/components/schemas/DetailsEmployment' - $ref: '#/components/schemas/DetailsMotorVehicle' - $ref: '#/components/schemas/DetailsSSN' - $ref: '#/components/schemas/DetailsSexOffender' - $ref: '#/components/schemas/DetailsGlobalWatchlist' - $ref: '#/components/schemas/DetailsFACIS' - $ref: '#/components/schemas/DetailsIdentity' - $ref: '#/components/schemas/DetailsCPLC' - $ref: '#/components/schemas/DetailsOIG' - $ref: '#/components/schemas/DetailsOtherService' - $ref: '#/components/schemas/DetailsInternational' - $ref: '#/components/schemas/DetailsLegal' - $ref: '#/components/schemas/DetailsPayment' - $ref: '#/components/schemas/DetailsMaskShipment' description: >- Details of the case data. The properties vary based on the type of service. serviceCategory: $ref: '#/components/schemas/ServiceCategory' serviceCategoryId: $ref: '#/components/schemas/ServiceCategoryId' serviceSubCategory: $ref: '#/components/schemas/ServiceSubCategory' type: string serviceSubCategoryId: $ref: '#/components/schemas/ServiceSubCategoryId' type: string pendingStatus: $ref: '#/components/schemas/CaseDataPendingStatus' type: string pendingStatusId: $ref: '#/components/schemas/CaseDataPendingStatusID' type: string locked: type: boolean 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 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. - acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6 - clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33 - consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 - not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8 - canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d - complete (done without prejudice): case-data-status-complete - pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 - 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 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 DetailsNationalCriminal: title: DetailsNationalCriminal type: object description: Details from a national criminal search. examples: - serviceId: d8e3dbdb-c2d7-4787-9736-86fffab74da4 dateCompleted: '2024-08-14T14:33:36.197+00:00' timeToComplete: 2 days records: - state: FL county: Putnam County charge: GRAND THEFT AUTO offenseType: FELONY disposition: ADJUDICATED GUILTY/DELINQUENT dispositionDate: '2018-05-15' caseNumber: 11103000089CFYX contextualData: state=FL county=Putnam County charge=GRAND THEFT AUTO - state: FL county: Putnam County charge: CRIMINAL MISCHIEF - MORE THAN $200 LESS THAN $1000 offenseType: MISDEMEANOR disposition: DROPPED/ABANDONED BY PROSECUTOR dispositionDate: '2018-05-15' caseNumber: 11106000525CFMX contextualData: >- state=FL county=Putnam County charge=CRIMINAL MISCHIEF - MORE THAN $200 LESS THAN $1000 properties: serviceId: type: string enum: - d8e3dbdb-c2d7-4787-9736-86fffab74da4 dateCompleted: type: string format: date-time example: '2024-05-17T19:47:14.885+00:00' timeToComplete: type: string example: 2 days additionalInfo: type: string records: type: array description: Records found from the criminal search. items: type: object properties: state: type: string example: FL county: type: string example: Putnam County charge: type: string example: GRAND THEFT AUTO offenseType: type: string example: FELONY disposition: type: string example: DROPPED/ABANDONED BY PROSECUTOR dispositionDate: type: string format: date example: '2018-05-15' caseNumber: type: string example: 11103000089CFYX comments: type: string contextualData: type: string DetailsFederalCriminal: title: DetailsFederalCriminal type: object description: Details from a federal criminal search. examples: - serviceId: fa226cb7-1214-4cdf-9296-6120a7376926 dateCompleted: '2024-08-14T14:34:17.741+00:00' timeToComplete: 2 days records: - state: PENNSYLVANIA county: PENNSYLVANIA EASTERN charge: 'Citation: 12.2345 M / Jaywalking' offenseType: Misdemeanor disposition: Guilty dispositionDate: '2019-06-02' caseNumber: 00230-FHB-123456 jurisdiction: PENNSYLVANIA EASTERN fileDate: '2019-06-02' contextualData: county=PENNSYLVANIA EASTERN jurisdiction=PENNSYLVANIA EASTERN properties: serviceId: type: string enum: - ee774b82-a411-4e2b-a38f-c0641bd836e7 dateCompleted: type: string format: date-time example: '2024-05-17T19:47:14.885+00:00' timeToComplete: type: string example: 2 days 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. example: PENNSYLVANIA county: type: string description: Applicable to federal district searches. example: PENNSYLVANIA EASTERN charge: type: string example: 'Citation: 12.2345 M / Jaywalking' offenseType: type: string example: Misdemeanor disposition: type: string example: Guilty dispositionDate: type: string format: date example: '2019-06-22' caseNumber: type: string example: 00230-FHB-123456 comments: type: string jurisdiction: type: string example: PENNSYLVANIA EASTERN fileDate: type: string format: date example: '2019-06-22' contextualData: type: string DetailsCountyCriminal: type: object examples: - jurisdictions: - alias: JONES, STEPHEN jurisdiction: NY-NYOCA status: f657c777-c38d-489b-ac26-dd9bf0a88724 - alias: JONES, STEPHEN jurisdiction: NJ-ESSEX status: 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 records: - comments: null caseNumber: 502008CF012155YXYXMB jurisdiction: NY-NYOCA fileDate: '2019-07-10' charge: 1. Possession Of Schedule 4 Substance offenseType: Felony disposition: Pre Trial Intervention dispositionDate: '2019-08-01' nameOnRecord: JONES, STEPHEN state: NY county: NYOCA contextualData: state=NY county=NYOCA jurisdiction=NY-NYOCA - comments: null caseNumber: 502008CF012155YXYXMB jurisdiction: NY-NYOCA fileDate: '2019-07-10' charge: 2. Possession Of Schedule 2 Substance offenseType: Felony disposition: Pre Trial Intervention dispositionDate: '2019-08-01' nameOnRecord: JONES, STEPHEN state: NY county: NYOCA contextualData: state=NY county=NYOCA jurisdiction=NY-NYOCA - comments: null caseNumber: 502008CF012155YXYXMB jurisdiction: NY-NYOCA fileDate: '2019-07-10' charge: 3. Attempt To Obtain Controlled Substance By Fraud offenseType: Felony disposition: Pre Trial Intervention dispositionDate: '2019-08-01' nameOnRecord: JONES, STEPHEN state: NY county: NYOCA contextualData: state=NY county=NYOCA jurisdiction=NY-NYOCA 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. example: JONES, STEPHEN 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 example: 123456CF012155YXYXMB jurisdiction: type: string example: NJ-ESSEX fileDate: type: string format: date example: '2019-07-10' charge: type: string example: 1. Unregistered Motor Vehicle offenseType: type: string example: Traffic disposition: type: string example: Nolle Prosse dispositionDate: type: string format: date example: '2019-08-01' nameOnRecord: type: string example: JONES, STEPHEN state: type: string example: NJ county: type: string example: ESSEX contextualData: type: string status: $ref: '#/components/schemas/CaseDataStatusID' description: >- The status ID of the jurisdictional search. - acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6 - clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33 - consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 - not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8 - canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d - complete (done without prejudice): case-data-status-complete - pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 - error (error during processing): case-data-status-error modifiedDate: type: string format: date-time example: '2024-08-07T21:54:04.000Z' createdDate: type: string description: The date and time that the service was ordered. format: date-time example: '2024-08-07T21:54:01.000Z' completedDate: type: string format: date-time example: '2024-08-07T21:54:03.000Z' dateCompleted: type: string format: date-time example: '2024-08-08T14:34:59.271Z' timeToComplete: type: string example: 16 hours 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 example: 123456CF012155YXYXMB jurisdiction: type: string example: NJ-ESSEX fileDate: type: string format: date example: '2019-07-10' charge: type: string example: 1. Possession Of Schedule 4 Substance offenseType: type: string example: Felony disposition: type: string example: Pre Trial Intervention dispositionDate: type: string format: date example: '2019-08-01' nameOnRecord: type: string example: JONES, STEPHEN state: type: string example: NJ county: type: string example: ESSEX contextualData: type: string DetailsStateCriminalCourt: title: DetailsStateCriminalCourt type: object description: Details from a state criminal court search. examples: - serviceId: c407f6dd-523e-4627-a4d9-8f52d30ee744 dateCompleted: '2024-05-17T19:47:14.885+00:00' timeToComplete: 2 days jurisdictions: - status: f657c777-c38d-489b-ac26-dd9bf0a88724 jurisdiction: FLORIDA records: - state: FLORIDA charge: 1. Unregistered Motor Vehicle offenseType: Traffic disposition: Nolle Prosse dispositionDate: '2012-10-16' caseNumber: 123456CT024900YXYXXSB jurisdiction: FLORIDA fileDate: '2008-08-17' contextualData: state=FLORIDA jurisdiction=FLORIDA externalSearchAndHasResults: false properties: serviceId: type: string enum: - c407f6dd-523e-4627-a4d9-8f52d30ee744 dateCompleted: type: string format: date-time example: '2024-05-17T19:47:14.885+00:00' timeToComplete: type: string example: 2 days additionalInfo: type: string jurisdictions: type: array description: Details about each jurisdictional search. items: type: object properties: status: $ref: '#/components/schemas/CaseDataStatusID' description: >- The status ID of the jurisdictional search. - acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6 - clear (done and good): e086eea7-e4b7-4c74-ac04-4c3b51c23a33 - consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 - not_found (unable to verify): 96e0420a-4396-4bd1-9b54-447f00eb3ed8 - canceled (not performed): 3d726502-d2e2-4d10-859b-8a218f22086d - complete (done without prejudice): case-data-status-complete - pending (in progress): 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 - error (error during processing): case-data-status-error jurisdiction: type: string example: FLORIDA records: type: array description: Records found from the criminal search. items: type: object properties: state: type: string example: FLORIDA charge: type: string example: 1. Unregistered Motor Vehicle offenseType: type: string example: Traffic disposition: type: string example: Nolle Prosse dispositionDate: type: string format: date example: '2012-10-16' caseNumber: type: string example: 123456CT024900YXYXXSB comments: type: string jurisdiction: type: string example: FLORIDA fileDate: type: string format: date example: '2008-08-17' contextualData: type: string externalSearchAndHasResults: type: boolean DetailsStateCriminalDatabase: title: DetailsStateCriminalDatabase type: object description: Details from a state criminal search. examples: - serviceId: d9381240-6230-40ec-9e11-35703e8041bc dateCompleted: '2024-05-17T19:47:14.885+00:00' timeToComplete: 2 days records: - state: AZ AOC charge: OPEN CONTAINER OF LIQUOR W/IN VEH offenseType: MISDEMEANOR disposition: PLEA GUILTY/RESP SENT IMPOSED dispositionDate: '2019-07-09' caseNumber: M-0000-3583999 comments: 'Case#: M-0000-3583999 Court: Phoenix Municipal' jurisdiction: AZ AOC fileDate: '2019-07-10' contextualData: state=AZ AOC jurisdiction=AZ AOC properties: serviceId: type: string enum: - d9381240-6230-40ec-9e11-35703e8041bc dateCompleted: type: string format: date-time example: '2024-05-17T19:47:14.885+00:00' timeToComplete: type: string example: 2 days additionalInfo: type: string records: type: array description: Records found from the criminal search. items: type: object properties: state: type: string example: AZ AOC charge: type: string example: SELLING ALCOHOL TO MINOR; MINOR IN POSSE offenseType: type: string example: MISDEMEANOR disposition: type: string example: PLEA GUILTY/RESP SENT IMPOSED dispositionDate: type: string format: date example: '2019-07-26' caseNumber: type: string example: M-0000-1234567 comments: type: string example: 'Case#: M-0000-1234567 Court: Phoenix Municipal' jurisdiction: type: string example: AZ AOC fileDate: type: string format: date example: '2019-07-16' contextualData: type: string DetailsDrug: title: DetailsDrug type: object description: Details from a drug screening. examples: - dateCompleted: '2024-06-18T16:54:10.635Z' timeToComplete: 3 days effectiveDate: '2024-06-18T16:54:00.000Z' externalId: kj0cKdOSgqKlaCRm2LSQ scheduledDate: '2024-06-13T16:53:00.000Z' expirationDate: '2024-06-20T16:53:00.000Z' clientName: Example Company clientAccount: '629236' clientSubAccount: '26' clinicId: '9588' clinicName: Test Clinic clinicAddress1: 7500 W 110th Street clinicAddress2: '' clinicCity: Omaha clinicState: NE clinicZip: '66210' clinicPhoneNumber: 800-555-0175 clinicFaxNumber: '8005550100' network: In Network Tier 1 firstName: Jack lastName: Williams status: Negative chainOfCustody: '2123312312' collectionDate: '2024-06-13T19:54:00.000Z' collectionData: regulation: Non-DOT specimenType: Breath dilute: Not Dilute analytes: resultId: analyte-negative result: Negative panelId: 'null' analyteId: ethanol-breath analyte: Ethanol Breath specimenType: Breath screeningCutoffValue: '10' screeningCutoffUnit: ng/mL confirmationCutoffValue: '10' confirmationCutoffUnit: ng/mL quantity: '0' confirmationNumber: AI123456789 labReceivedDate: '2024-06-13T20:54:00.000Z' labReportDate: '2024-06-14T16:54:00.000Z' verificationDate: '2024-06-15T16:54:00.000Z' labName: Example Lab collectionSite: '12' collectionSiteInNetwork: In Network Tier 1 collectionSitePhoneNumber: 800-555-0175 eCupCollection: Not an eCup Collection donorName: Williams, Jack dob: 3/15/1983 ssnLast4: '3333' homePhone: '' homePhoneExt: '' workPhone: 800-555-0180 workPhoneExt: '' otherIDType: '' reasonForTest: Pre-Employment specimenCollector: JD locationInfo: Test Clinic mroAddress: 8140 Ward Parkway mroCity: Omaha mroName: Dr. Kirk Roberts, M.D. mroPhone: 800-555-0190 mroState: NE mroZip: '64114' result: negative resultCode: '1' resultId: drugtest-negative comments: Results are clean additionalInfo: '' properties: dateCompleted: type: string format: date-time example: '2024-06-18T16:54:10.635Z' timeToComplete: type: string example: 3 days effectiveDate: type: string format: date-time example: '2024-06-18T16:54:00.000Z' externalId: type: string description: The service provider's ID for the candidate. scheduledDate: type: string format: date-time example: '2024-06-13T16:53:00.000Z' expirationDate: type: string format: date-time example: '2024-06-20T16:53:00.000Z' 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. example: In Network Tier 1 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 example: '2024-06-13T19:54:00.000Z' 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: '#/components/schemas/AnalyteDetails' confirmationNumber: type: string description: The service provider confirmation number. labReceivedDate: type: string format: date-time example: '2024-06-13T20:54:00.000Z' description: The date the specimen was received at the lab. labReportDate: type: string format: date-time example: '2024-06-14T16:54:00.000Z' description: The date the specimen results were reported by the lab. verificationDate: type: string format: date-time example: '2024-06-15T16:54:00.000Z' 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. example: In Network Tier 1 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. example: 1/1/1980 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. example: Passport reasonForTest: type: string description: The reason for the test. example: Pre-employment 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 DetailsOHS: title: DetailsOHS type: object description: >- Details from an occupational health screening, such as a physical, vaccination, titer, or TB test. examples: - dateCompleted: '2024-06-18T00:34:00.000Z' timeToComplete: 3 days effectiveDate: '2024-06-12T00:33:00.000Z' externalId: kj0cKdOSgqKlaCRm2LSQ confirmationNumber: kj0cKdOSgqKlaCRm2LSQ scheduledDate: '2024-06-13T00:33:00.000Z' expirationDate: '2024-06-20T00:33:00.000Z' clientName: Example Company clientAccount: '629236' clientSubAccount: '26' clinicId: '9588' clinicName: Test Clinic clinicAddress1: 7500 W 110th Street clinicAddress2: '' clinicCity: Omaha clinicState: NE clinicZip: '66210' clinicPhoneNumber: 800-555-0175 clinicFaxNumber: '8005550100' network: In Network Tier 1 firstName: Jack lastName: Williams birthDate: 03/15/1983 ssnLast4: '3333' source: escreen physicalID: '238170' verificationType: physical componentId: '35' componentDescription: Chest X-Ray 1 View status: Complete result: Within Normal Limits resultId: ohs-result-165-acknowleged resultCode: '165' resultDate: '2024-06-14T00:34:00.000Z' resultDueToReason: '' resultExpirationDate: '' resultStatusDescription: Within Normal Limits partialReasons: [] examDate: 6/14/2024 followUpDate: '' certExpirationDate: '' tbReadDate: '' comments: Results are clean. clientAddress1: 7878 Guy St clientAddress2: '' clientCity: Omaha clientContact: Rosario S. clientState: NE clientZip: '64086' collectionSitePhoneNumber: 800-555-0155 cdlFlag: '0' overallStatusDescription: Complete physicalReasonDescription: New Certification additionalInfo: '' properties: dateCompleted: type: string format: date-time example: '2024-06-18T00:34:00.000Z' description: The date and time when the service was complete. timeToComplete: type: string example: 3 days effectiveDate: type: string format: date-time example: '2024-06-12T00:33:00.000Z' 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 example: '2024-06-13T00:33:00.000Z' expirationDate: type: string format: date-time example: '2024-06-20T00:33:00.000Z' 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. example: In Network Tier 1 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. example: 01/21/1980 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 example: '2024-06-14T00:34:00.000Z' 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 example: 6/14/2024 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 DetailsEducation: title: DetailsEducation type: object examples: - dateCompleted: '2024-05-17T21:14:30.846+00:00' timeToComplete: 4 days records: - statusId: 1a8490cb-084d-4209-bf2f-d46e41d760d6 institution: Boston University location: Boston, MA receivedResults: 'yes' applicantProvided: degree: BA major: Communications dateSpan: 1995-08 TO 1999-05 institutionProvided: degree: BA major: Communications dateSpan: 1995-08 TO 1999-05 testimonyId: f3dd7129-e553-4870-b99e-472de8d6c522 - statusId: 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 description: Details from an education verification. properties: dateCompleted: type: string format: date-time example: '2024-05-17T21:14:30.846+00:00' timeToComplete: type: string example: 4 days additionalInfo: type: string records: type: array items: type: object properties: statusId: $ref: >- #/components/schemas/EducationVerificationIndividualRecordStatus institution: type: string location: type: string receivedResults: $ref: '#/components/schemas/EducationEmploymentReceivedResults' applicantProvided: type: object properties: degree: type: string major: type: string gpa: type: string dateSpan: type: string example: 1995-08 TO 1999-05 comments: type: string institutionProvided: type: object properties: degree: type: string major: type: string gpa: type: string dateSpan: type: string example: 1995-08 TO 1999-05 comments: type: string testimonyId: type: string description: Associated testimony identifier searchId: type: string description: Associated case data search identifier DetailsEmployment: title: DetailsEmployment type: object examples: - dateCompleted: '2024-05-17T20:16:30.846+00:00' timeToComplete: 6 days records: - statusId: 8f29e0de-10f2-4c84-8379-16c6eb7cdf64 - statusId: 1a8490cb-084d-4209-bf2f-d46e41d760d6 employer: Employer B location: Washington, D.C. receivedResults: 'yes' applicantProvided: position: Nurse dateSpan: 2000 - 10 to 2003 - 10 institutionProvided: position: Nurse dateSpan: 2000 - 10 to 2003 - 10 testimonyId: f3dd7129-e553-4870-b99e-472de8d6c522 description: Details from an employment verification. properties: dateCompleted: type: string format: date-time example: '2024-05-17T20:16:30.846+00:00' timeToComplete: type: string example: 6 days additionalInfo: type: string records: type: array items: type: object properties: statusId: $ref: >- #/components/schemas/EmploymentVerificationIndividualRecordStatus employer: type: string location: type: string receivedResults: $ref: '#/components/schemas/EducationEmploymentReceivedResults' applicantProvided: type: object properties: position: type: string salary: type: string dateSpan: type: string example: 2000 - 10 to 2003 - 10 additionalInfo: type: string institutionProvided: type: object properties: position: type: string salary: type: string dateSpan: type: string example: 2000 - 10 to 2003 - 10 additionalInfo: type: string testimonyId: type: string description: Associated testimony identifier searchId: type: string description: Associated case data search identifier DetailsMotorVehicle: title: DetailsMotorVehicle type: object examples: - dateCompleted: '2024-06-17T19:56:43.925+00:00' timeToComplete: 2 days records: - state: CALIFORNIA licenseNumber: E78904321 issueDate: '2022-04-22' expirationDate: '2026-04-22' licenseClass: C classDescription: REGULAR LICENSE type: PERSONAL status: VALID fullName: WILLIAMS, JACK events: - state: CA eventType: Violation description: SPEEDING INTERMEDIATE (11-19 OVER) eventDate: '2022-05-24' convictionDate: '2022-06-13' disposition: GUILTY stateCode: 346.57(5) acd: S92 avd1: SA10 avd2: SA10 avd3: SA10 location: LOS ANGELES CITY MUNICIPAL COURT - WESTWOOD commercial: false hazMat: false - state: CA eventType: Suspension description: FAILURE TO PAY FORFEITURE eventDate: '2022-08-22' clearDate: '2023-05-15' stateCode: FPF acd: D53 avd1: DE12 avd2: DE12 avd3: DE12 commercial: false hazMat: false contextualData: state=CALIFORNIA licenseNumber=E78904321 fullName=WILLIAMS, JACK hasResults: true description: Details from a motor vehicle records check. properties: dateCompleted: type: string format: date-time example: '2024-06-17T19:56:43.925+00:00' timeToComplete: type: string example: 2 days additionalInfo: type: string records: type: array items: type: object properties: state: type: string licenseNumber: type: string issueDate: type: string format: date example: '2022-04-22' expirationDate: type: string format: date example: '2026-04-22' 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 example: '2015-04-12' offenseDate: type: string format: date example: '2015-04-12' description: If applicable. convictionDate: type: string format: date example: '2015-04-12' description: If applicable. clearDate: type: string format: date example: '2015-04-12' 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. DetailsSSN: title: DetailsSSN type: object examples: - dateCompleted: '2024-06-17T18:58:20.113+00:00' timeToComplete: instant records: - firstName: Jack lastName: Williams dob: '1983-03-15' city: New York state: NY zip: '10031' ssn: XXX-XX-XXXX dateFirstReported: 2019-02 dateLastReported: 2019-07 nameScore: 30 dobMatch: false county: NEW YORK - firstName: Jack lastName: Williams dob: '1983-03-15' city: Montclair state: NJ zip: '07042' ssn: XXX-XX-XXXX dateFirstReported: 2018-01 dateLastReported: 2018-05 nameScore: 30 dobMatch: false county: ESSEX results: true description: Details from a Social Security number (SSN) trace. properties: dateCompleted: type: string format: date-time example: '2024-06-17T18:58:20.113+00:00' timeToComplete: type: string example: instant additionalInfo: type: string records: type: array items: type: object properties: firstName: type: string lastName: type: string middleName: type: string dob: type: string format: date example: '1983-03-15' city: type: string state: type: string zip: type: string ssn: type: string enum: - XXX-XX-XXXX dateFirstReported: type: string example: 2018-01 dateLastReported: type: string example: 2018-05 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 examples: - dateCompleted: '2024-06-17T19:51:30.985+00:00' timeToComplete: instant records: - charge: COMMUNICATION WITH MINOR FOR IMMORAL PURPOSES offenseType: FELONY dispositionDate: '2019-07-02' disposition: GUILTY caseNumber: PD 1234567.9876543 FG comments: 'Provider: Washington Sex Offender Registry' contextualData: >- charge=COMMUNICATION WITH MINOR FOR IMMORAL PURPOSES offenseType=FELONY comments=Provider: Washington Sex Offender Registry description: Details from a sex offender search. properties: dateCompleted: type: string format: date-time example: '2024-06-17T19:51:30.985+00:00' timeToComplete: type: string example: instant additionalInfo: type: string records: type: array items: type: object properties: charge: type: string offenseType: type: string dispositionDate: type: string format: date example: '2015-08-21' disposition: type: string caseNumber: type: string comments: type: string contextualData: type: string DetailsGlobalWatchlist: title: DetailsGlobalWatchlist type: object examples: - dateCompleted: '2024-04-05T20:22:07.735+00:00' timeToComplete: instant records: - provider: Federal Bureau of Prisons charge: UNSPECIFIED offenseType: Crime referenceNumber: 010203-0203 contextualData: >- provider=Federal Bureau of Prisons jurisdiction= charge=UNSPECIFIED offenseType=Crime - provider: System for Award Management (SAM) - Excluded Parties List charge: UNSPECIFIED offenseType: Crime contextualData: >- provider=System for Award Management (SAM) - Excluded Parties List jurisdiction= charge=UNSPECIFIED offenseType=Crime description: Details from a global watchlist records check. properties: dateCompleted: type: string format: date-time example: '2024-06-17T20:24:48.920Z' timeToComplete: type: string example: instant 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 example: '2015-04-15' disposition: type: string referenceNumber: type: string comments: type: string contextualData: type: string DetailsFACIS: title: DetailsFACIS type: object examples: - dateCompleted: '2024-06-17T22:03:58.586+00:00' timeToComplete: 2 days additionalInfo: '' records: - sanctionType: Board Action sanctionDate: '2020-01-28' contextualData: sanctionType=Board Action description: Details from a Fraud Abuse Control Information System (FACIS) search. properties: dateCompleted: type: string format: date-time example: '2024-06-17T22:03:58.586+00:00' timeToComplete: type: string example: 2 days additionalInfo: type: string records: type: array items: type: object properties: sanctionType: type: string sanctionDate: type: string format: date example: '2015-04-18' specialty: type: string occupation: type: string comments: type: string upin: type: string contextualData: type: string DetailsIdentity: title: DetailsIdentity type: object examples: - dateCompleted: 1712703321520 timeToComplete: instant additionalInfo: '' serviceId: service-idv-id-liveliness verificationAttempts: - verificationResult: passed idvProviderRefId: D3CC823DF4293926C29DDBD72F8DD2E7 idvProvider: Identity Provider adjudicator: system completionStamp: 1712703321520 images: - imageType: drivers_license secureImageId: c872f431-e9e9-3c82-8896-8dd0a53d029d - imageType: liveliness secureImageId: d66b0fc8-a171-4a1b-8ad0-a6cb4aa49534 - imageType: signature secureImageId: 9f6391e3-4d76-4011-bc11-8dd0a53d029d - imageType: id_thumbnail secureImageId: 946f932e-4703-4ddb-9660-8eba53edf337 description: Details from an identity verification. properties: dateCompleted: type: number example: 1712703321520 timeToComplete: type: string example: instant 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`. example: 1712703321520 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 DetailsCPLC: title: DetailsCPLC type: object description: Details from a Professional License and Certification verification. examples: - dateCompleted: '2024-05-17T21:14:30.846Z' timeToComplete: instant comments: '' serviceContext: cplcId: cb3dac22-db86-44df-8193-877559b3e8dc fields: - fieldId: licenseNumber value: 987654RN - fieldId: firstName value: Yuri - fieldId: lastName value: Smith - fieldId: state value: CA licStatus: UNENCUMBERED issueDate: '2001-08-10' expirationDate: '2024-06-30' flagged: false additionalInfo: ' Active: YES Compact Status: N/A' source: nursys rawDataType: json rawDataKey: dd123c6b-1111-1111-9eb7-1e7349b56691 properties: dateCompleted: type: string format: date-time example: '2024-05-17T21:14:30.846Z' timeToComplete: type: string example: instant 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 example: '2001-08-10' expirationDate: type: string format: date example: '2024-06-30' flagged: type: boolean additionalInfo: type: string description: Always empty, except for nursys. source: type: string rawDataType: type: string example: json rawDataKey: type: string description: The S3 key to the raw data. DetailsOIG: title: DetailsOIG type: object examples: - result: no-exclusion-found input: givenName: Williams familyName: Jack govtId: 111-22-3333 dob: '1983-03-15' resultsPage: secureDocumentId: 5fee28bc-6dc4-42fc-2dcd-22c4a4858e71 nameMatchResults: [] dateCompleted: 1718649155997 timeToComplete: 2 days source: karmacheck additionalInfo: '' 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 example: 111-22-3333 dob: type: string format: date example: '1983-03-15' 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 example: '2020-01-15' waiver: type: string dateCompleted: type: number example: 1718649155997 timeToComplete: type: string example: 2 days source: type: string example: karmacheck 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. examples: - status: Clear statusId: e086eea7-e4b7-4c74-ac04-4c3b51c23a33 pendingStatusId: '' additionalInfo: '' dateCompleted: '2024-06-18T23:14:06.594Z' timeToComplete: 5 days source: karmacheck properties: status: type: string statusId: type: string pendingStatusId: type: string additionalInfo: type: string dateCompleted: type: string format: date-time example: '2024-06-17T22:03:58.586Z' timeToComplete: type: string example: 2 days source: type: string example: karmacheck 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 example: certn dateCompleted: type: string format: date-time example: '2024-06-11T23:02:23.156090Z' description: The date when the service was completed. timeToComplete: type: string example: instant 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. examples: - dateCompleted: 1713571200000 timeToComplete: instant additionalInfo: null type: pdf uri: Disclosure-abc1de23-45c0-4443-928b-8729790c6e07 ackData: sendReport: true valid: true list: - legalType: general-ca-disclosure signature: Jack Williams - legalType: state-city-all-disclosure signature: Jack Williams properties: dateCompleted: type: number example: 1713571200000 timeToComplete: type: string example: instant additionalInfo: type: - string - 'null' type: type: string example: pdf uri: type: string ackData: allOf: - type: object properties: valid: type: boolean - oneOf: - $ref: '#/components/schemas/LegalAcknowledgmentSignature' - $ref: '#/components/schemas/LegalAcknowledgmentDisclosures' - $ref: '#/components/schemas/LegalAcknowledgmentDisclosure' DetailsPayment: title: DetailsPayment type: object examples: - dateCompleted: 1718670225405 timeToComplete: instant additionalInfo: null orderPrice: 2995 paymentStatus: paid records: - action: payment paymentDate: 2024-06-18 00:23:43 UTC amount: 2995 paymentProviderId: payment-provider-stripe description: Details of a payment. properties: dateCompleted: type: number example: 1718670225405 timeToComplete: type: string example: instant additionalInfo: type: - string - 'null' orderPrice: type: integer example: 2995 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 example: 2024-06-18 00:23:43 UTC amount: type: number example: 2995 paymentProviderId: type: string example: payment-provider-stripe DetailsMaskShipment: title: DetailsMaskShipment description: Details of a mask shipment. allOf: - $ref: '#/components/schemas/CaseOrderDataShipment' - type: object properties: trackingNumber: type: string example: 1ZE660080325370038 courier: type: string example: UPS dateCompleted: type: string format: date-time example: '2024-07-16T20:20:15.196Z' timeToComplete: type: string example: 5 days additionalInfo: type: string examples: - recipientName: John Smith address1: 1952 Whitney Avenue address2: Unit 2 addressType: home addressSource: homeAddress city: Hamden state: CT postalCode: '06517' shippingMethod: Overnight maskType: Honeywell DC365 N95 trackingNumber: 1ZE660080325370038 courier: UPS dateCompleted: '2024-07-16T20:20:15.196Z' timeToComplete: 5 days additionalInfo: '' 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 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. 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: '#/components/schemas/AnalyteID' analyte: $ref: '#/components/schemas/AnalyteName' specimenType: type: string enum: - Urine - Breath screeningCutoffValue: type: string description: >- The numeric value of the cutoff concentration for the screening test. example: '10' screeningCutoffUnit: type: string description: The unit of measurement associated with the screening cutoff value. example: ng/mL confirmationCutoffValue: type: string description: >- The numeric value of the cutoff concentration for the confirmation test. example: '10' confirmationCutoffUnit: type: string description: >- The unit of measurement associated with the confirmation cutoff value. example: ng/mL quantity: type: string description: The numeric value of the detected concentration. example: '0' examples: - resultId: analyte-negative result: Negative panelId: '1200' analyteId: amphetamines-amp analyte: Amphetamines (AMP) specimenType: Urine screeningCutoffValue: '1000' screeningCutoffUnit: ng/mL confirmationCutoffValue: '500' confirmationCutoffUnit: ng/mL quantity: '0' EducationVerificationIndividualRecordStatus: title: EducationVerificationIndividualRecordStatus description: >- The status ID of an individual education record's status in the context of an Education Verification case data record. - acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6 - consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 - 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 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. EmploymentVerificationIndividualRecordStatus: title: EmploymentVerificationIndividualRecordStatus description: >- The status ID of an individual employment record's status in the context of an Employment Verification case data record. - acknowledge (done positive): 1a8490cb-084d-4209-bf2f-d46e41d760d6 - consider (done and needs review): f657c777-c38d-489b-ac26-dd9bf0a88724 - 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 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. 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: '#/components/schemas/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. 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. CaseOrderDataShipment: title: CaseOrderDataShipment type: object description: The candidate data when `caseOrderDataTypeId` is `codt-shipment`. examples: - recipientName: John Smith address1: 1952 Whitney Avenue address2: Unit 2 addressType: home addressSource: homeAddress city: Hamden state: CT postalCode: '06517' shippingMethod: Overnight maskType: Honeywell DC365 N95 - recipientName: John Smith c/o KC Clinic address1: 1952 Whitney Avenue addressType: clinic city: Hamden state: CT postalCode: '06517' shippingMethod: Overnight maskType: Honeywell DC365 N95 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). 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. 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. securitySchemes: JWT: type: http scheme: bearer ````