openapi: 3.2.0
info:
  title: KarmaCheck Case 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: Case
paths:
  /case/id/{caseId}/cancel:
    parameters:
    - schema:
        type: string
      name: caseId
      in: path
      required: true
      description: the case you'd like to cancel
    post:
      tags:
      - Case
      summary: Cancel a case
      operationId: post-case-id-caseId-cancel
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Returned if case is not found
          content: {}
        '422':
          description: Unprocessable Entity (WebDAV)
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                  statusCode:
                    type: integer
                x-examples:
                  Example 1:
                    message: Service cannot be canceled.
                    error: Unprocessable Entity
                    statusCode: 422
              examples:
                Example 1:
                  value:
                    message: Cannot cancel a case that has already started.
                    error: Unprocessable Entity
                    statusCode: 422
                Example 2:
                  value:
                    message: Unable to cancel case.
                    error: Unprocessable Entity
                    statusCode: 422
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                  statusCode:
                    type: integer
                x-examples:
                  Example 1:
                    message: Service cannot be canceled.
                    error: Unprocessable Entity
                    statusCode: 422
              examples:
                Example 1:
                  value:
                    message: An error has occurred while canceling the case
                    error: Internal Server Error
                    statusCode: 500
  /case/id/{caseId}/services/cancel:
    parameters:
    - schema:
        type: string
      name: caseId
      in: path
      required: true
      description: The case containing the service you would like to cancel
    post:
      tags:
      - Case
      summary: Cancel Case Service
      operationId: post-case-id-caseId-service-cancel
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-examples:
                Example 1:
                  serviceIds:
                  - '{{Service}}'
              required:
              - serviceIds
              properties:
                serviceIds:
                  type: array
                  items:
                    type: string
            examples:
              Example 1:
                value:
                  serviceIds:
                  - AAAAAA-AAAAAAA-AAAAAAA-AAAAAAA
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Returned if case is not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '422':
          description: Unprocessable Entity (WebDAV)
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                  statusCode:
                    type: integer
                x-examples:
                  Example 1:
                    message: Service cannot be canceled.
                    error: Unprocessable Entity
                    statusCode: 422
              examples:
                Service cannot be canceled:
                  value:
                    message: Service cannot be canceled.
                    error: Unprocessable Entity
                    statusCode: 422
                SSN Trace required:
                  value:
                    message: SSN Trace is required when County, State, or Federal Criminal Search are ordered.
                    error: Unprocessable Entity
                    statusCode: 422
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                  statusCode:
                    type: integer
                x-examples:
                  Example 1:
                    message: An error has occurred while canceling the case
                    error: Internal Server Error
                    statusCode: 500
              examples:
                Example 1:
                  value:
                    message: An error has occurred while canceling the case
                    error: Internal Server Error
                    statusCode: 500
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
x-apievangelist-provenance:
  assembled: '2026-08-23'
  method: searched
  note: Reassembled verbatim from the 69 per-operation OpenAPI 3.1.0 YAML documents KarmaCheck publishes inside the markdown twins of its public API reference (https://developer.karmacheck.com/api-reference/<op>.md). Each page embeds a complete, single-operation slice of KarmaCheck's own openapi.json; the 69 slices merged with ZERO conflicting definitions. No content was authored, inferred, or padded by API Evangelist. KarmaCheck's consolidated export at https://developer.karmacheck.com/background-check-api/api-reference/openapi.json is login-gated (HTTP 302 to /login), so this reassembly is the only machine-readable form of the contract reachable without credentials.
  source_index: https://developer.karmacheck.com/sitemap.xml
  slices_merged: 69
  conflicts: 0