# KarmaCheck

## Docs

- [Authenticate API client](https://developer.karmacheck.com/api-reference/authentication/authenticate-api-client.md): Authenticates an API client with KarmaCheck so that they can access the KarmaCheck system.
- [Cancel a case](https://developer.karmacheck.com/api-reference/cancel-a-case.md)
- [Cancel Case Service](https://developer.karmacheck.com/api-reference/cancel-case-service.md)
- [Acknowledge Canada Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-canada-disclosure.md): Submits acknowledgement of a Canada Disclosure document for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a downloadable PDF file of the acknowledged disclosure.
- [Acknowledge Custom Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-custom-disclosure.md): Submits acknowledgement of a Custom Disclosure document for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a downloadable PDF file of the acknowledged disclosure.
- [Acknowledge E-Signature](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-e-signature.md): Submits acknowledgement of the e-Signature for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a PDF file of the e-Signature document, which includes the candidate's acknowledgment and is availa…
- [Acknowledge FCRA](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-fcra.md): Submits acknowledgement of the FCRA for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a downloadable PDF file of the acknowledged FCRA document.
- [Acknowledge International Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-international-disclosure.md): Submits acknowledgement of an International Disclosure document for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a downloadable PDF file of the acknowledged disclosure.
- [Acknowledge location-specific disclosures](https://developer.karmacheck.com/api-reference/candidate-onboarding/acknowledge-location-specific-disclosures.md): Submits acknowledgement of location-specific disclosures for tracking and auditing purposes. This action creates a case data record with the provided information. The system records the acknowledgment and generates a downloadable PDF file of the acknowledged disclosures.
- [Create candidate by proxy for invitation](https://developer.karmacheck.com/api-reference/candidate-onboarding/create-candidate-by-proxy-for-invitation.md): Creates the candidate object in KarmaCheck on behalf of the candidate so that there can be pre-population of PII before the candidate accepts an invitation and enters the system. The candidate will be directed to onboard the associated case via the one-time token link that will be provided by the AP…
- [Create testimony for case](https://developer.karmacheck.com/api-reference/candidate-onboarding/create-testimony-for-case.md): Stores personally identifiable information (PII) on a candidate in KarmaCheck. Only one piece of PII can be included in a single piece of testimony.
- [Detach testimony from case](https://developer.karmacheck.com/api-reference/candidate-onboarding/detach-testimony-from-case.md): Removes previously attached testimony from a case.
- [Get Canada Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-canada-disclosure.md): Retrieves a Canada Disclosure document to present to the candidate so that the candidate can acknowledge and continue the onboarding process. If the candidate has already acknowledged the disclosure, the response will indicate this and provide a valid `caseDataId` so that the details of the previous…
- [Get candidate for invitation](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-candidate-for-invitation.md): Retrieves the candidate information associated with an invitation.
- [Get countries](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-countries.md): Fetches the list of countries and their respective ISO 3166 codes to use for creating testimony with proper codes.
- [Get Custom Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-custom-disclosure.md): Retrieves a Custom Disclosure document to present to the candidate so that the candidate can acknowledge and continue the onboarding process. If the candidate has already acknowledged the disclosure, the response will indicate this and provide a valid `caseDataId` so that the details of the previous…
- [Get E-Signature](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-e-signature.md): Retrieves an e-Signature consent document and form that can be presented to and acknowledged by the candidate as part of the onboarding process. If the candidate has already acknowledged it, the response will indicate this as well as provide the `caseDataId` of the acknowledgement, which can be used…
- [Get FCRA](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-fcra.md): Retrieves a Fair Credit Reporting Act (FCRA) consent document and form that can be presented to and acknowledged by the candidate as part of the onboarding process. If the candidate has already acknowledged it, the response will indicate this as well as provide the `caseDataId` of the acknowledgemen…
- [Get International Disclosure](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-international-disclosure.md): Retrieves an International Disclosure document to present to the candidate so that the candidate can acknowledge and continue the onboarding process. If the candidate has already acknowledged the disclosure, the response will indicate this and provide a valid `caseDataId` so that the details of the…
- [Get invitation for case ID](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-invitation-for-case-id.md): Retrieves the invitation associated with a case.
- [Get legal acknowledgement status](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-legal-acknowledgement-status.md): Retrieves the candidate acknowledgment status of the specified legal document for the case. This can be used to determine whether the candidate can skip acknowledging that legal document if they leave and then continue their onboarding later or on another device, for example.
- [Get one-time token link](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-one-time-token-link.md): Retrieves a one-time token (OTT) URL to give to a candidate so that they can complete onboarding for a case. The returned URL contains a token, ensuring that the candidate secures their account before proceeding with onboarding.
- [Get secure image by ID](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-secure-image-by-id.md): Retrieves a secure image by its identifier.
- [Get testimony for case](https://developer.karmacheck.com/api-reference/candidate-onboarding/get-testimony-for-case.md): Retrieves the testimony attached to a case.
- [Refresh invitation for case](https://developer.karmacheck.com/api-reference/candidate-onboarding/refresh-invitation-for-case.md): Refreshes the expiration date for an existing invitation.
- [Request location-specific disclosures](https://developer.karmacheck.com/api-reference/candidate-onboarding/request-location-specific-disclosures.md): Retrieves location-specific disclosure documents and forms that can be presented to and acknowledged by the candidate as part of the onboarding process.
- [Resend case invitation](https://developer.karmacheck.com/api-reference/candidate-onboarding/resend-case-invitation.md): Resends the invitation email for a case. Note that a case can have only one active invitation at a time, and resending the invite actually creates and sends a new invitation with a new ID.
- [Update candidate for case](https://developer.karmacheck.com/api-reference/candidate-onboarding/update-candidate-for-case.md): Sets modifiable data for a candidate.
- [Update testimony for case](https://developer.karmacheck.com/api-reference/candidate-onboarding/update-testimony-for-case.md): Updates testimony associated with a case.
- [Add to order](https://developer.karmacheck.com/api-reference/cases/add-to-order.md): Adds the requested services to the existing ordered case. The requested services must be part of the package for the case. The authentication token must be for the group that the case is owned by.
- [Archive case](https://developer.karmacheck.com/api-reference/cases/archive-case.md): Archives a case so that it no longer appears in the KarmaCheck dashboard.
- [Begin processing case](https://developer.karmacheck.com/api-reference/cases/begin-processing-case.md): Begins the processing of screenings for a case.
- [Cancel case data search](https://developer.karmacheck.com/api-reference/cases/cancel-case-data-search.md): Endpoint to cancel individual case data search records.
- [Create case](https://developer.karmacheck.com/api-reference/cases/create-case.md): Orders a background check report and opens a case for tracking. The new case includes references to the package. Depending on the values entered in the request, the case goes through one of two flows:
- [Download legal doc for case data](https://developer.karmacheck.com/api-reference/cases/download-legal-doc-for-case-data.md): Downloads the PDF document for the legal service requested for a case. Legal checks are the various required authorizations collected from a candidate when they authorize a background check (e-signature, FCRA, and disclosures).
- [Download pre-adverse action document](https://developer.karmacheck.com/api-reference/cases/download-pre-adverse-action-document.md): Downloads the PDF file for the pre-adverse action notice or the case report that was active at the time of the pre-adverse action.
- [Find jurisdictions](https://developer.karmacheck.com/api-reference/cases/find-jurisdictions.md): Retrieves a list of relevant county and federal district jurisdictions based on a set of city/county/state combinations.
- [Get active cases](https://developer.karmacheck.com/api-reference/cases/get-active-cases.md): Retrieves all active cases for the `groupProfileId` on the token used. The response includes summary-level information with IDs for accessing details using other endpoints.
- [Get all cases](https://developer.karmacheck.com/api-reference/cases/get-all-cases.md): Retrieves all cases (both active and archived) for the `groupProfileId` on the token used. The response includes summary-level information with IDs for accessing details using other endpoints.
- [Get all services for case](https://developer.karmacheck.com/api-reference/cases/get-all-services-for-case.md): Retrieves a list of all services ordered for a case.
- [Get candidate info for case](https://developer.karmacheck.com/api-reference/cases/get-candidate-info-for-case.md): Retrieves information about the candidate associated with the case.
- [Get case](https://developer.karmacheck.com/api-reference/cases/get-case.md): Retrieves the details of a case by its ID. The response includes summary-level information with IDs for accessing details using other endpoints.
- [Get case configuration](https://developer.karmacheck.com/api-reference/cases/get-case-configuration.md): Returns the service configurations and contact information for a case. For information on how to create or update configuration options for a case, see [Create case](paths/~1case~1create/post) or [Add to order](paths/~1case~1id~1{caseId}~1add~1services/post).
- [Get case data by case ID](https://developer.karmacheck.com/api-reference/cases/get-case-data-by-case-id.md): Gets the details associated with services ordered and processed for a case.
- [Get custom report download URL](https://developer.karmacheck.com/api-reference/cases/get-custom-report-download-url.md): Returns a URL to download a PDF report for one or more case screenings (in other words, case data).
- [Get full report download URL](https://developer.karmacheck.com/api-reference/cases/get-full-report-download-url.md): Returns a URL to download a PDF report for the entire case and available attachments.
- [Get legal doc for case data](https://developer.karmacheck.com/api-reference/cases/get-legal-doc-for-case-data.md): Returns inline the PDF document for the legal service requested for a case. Legal checks are the various required authorizations collected from a candidate when they authorize a background check (e-signature, FCRA, and disclosures).
- [Get pre-adverse action document](https://developer.karmacheck.com/api-reference/cases/get-pre-adverse-action-document.md): Returns inline the PDF file for the pre-adverse action notice or the case report that was active at the time of the pre-adverse action.
- [Get services for case](https://developer.karmacheck.com/api-reference/cases/get-services-for-case.md): Retrieves a list of services ordered for a case. The list includes services of only one of the following types:
- [Place case](https://developer.karmacheck.com/api-reference/cases/place-case.md): Sets the status of a case to Placed in the system. Internally, the API sets the case's status to `Adjudicated` and its result to `Placed`. The secondary status, if any, gets reset.
- [Pre-adverse action for case](https://developer.karmacheck.com/api-reference/cases/pre-adverse-action-for-case.md): Begins the adverse action process for a case by putting the case into the Pre-Adverse Action status. This also sends a pre-adverse action notice to the candidate by email, which can also be downloaded from both the customer and candidate dashboards.
- [Unarchive case](https://developer.karmacheck.com/api-reference/cases/unarchive-case.md): Unarchives a case so that it reappears in the KarmaCheck dashboard. This operation reverses a previous archive operation on the case.
- [Get all enabled services for package](https://developer.karmacheck.com/api-reference/packages/get-all-enabled-services-for-package.md): Retrieves a list of all enabled services for a package.
- [Get package](https://developer.karmacheck.com/api-reference/packages/get-package.md): Retrieves the identifier and the name of a specific package.
- [Get package list](https://developer.karmacheck.com/api-reference/packages/get-package-list.md): Retrieves a list of enabled packages for the user to order new reports/cases. This list includes the identifier and the name of each package, sorted alphabetically by name.
- [Get services for package](https://developer.karmacheck.com/api-reference/packages/get-services-for-package.md): Retrieves a list of enabled services for a package. The list includes services of only one of the following types:
- [Create secure document records](https://developer.karmacheck.com/api-reference/secure-documents/create-secure-document-records.md): Creates secure document records in the KarmaCheck system and associates uploaded documents with an existing case.
- [Generate secure document upload URLs](https://developer.karmacheck.com/api-reference/secure-documents/generate-secure-document-upload-urls.md): Generates short-lived URLs that can be used to upload one or more secure documents to the KarmaCheck system. This API call is step 1 of 3 when adding a document to the system and linking it to a case.
- [Get secure document download URL](https://developer.karmacheck.com/api-reference/secure-documents/get-secure-document-download-url.md): Gets a URL from KarmaCheck, which can then be used to download a secure document. The URL will be valid for only 60 minutes, but once the download begins, the download can take as long as needed. The URL can also be reused as many times as needed during the 60-minute validity period.
- [Get secure document list](https://developer.karmacheck.com/api-reference/secure-documents/get-secure-document-list.md): Returns a list of the secure documents associated with a case.
- [Get secure document MIME types](https://developer.karmacheck.com/api-reference/secure-documents/get-secure-document-mime-types.md): Gets acceptable MIME types for secure documents.
- [Get secure document type list](https://developer.karmacheck.com/api-reference/secure-documents/get-secure-document-type-list.md): Returns a list of objects representing all secure document types in KarmaCheck. Among other uses, it enables population of the supported document types in a list that users can select from and associate with the document that they are uploading.
- [Get all CPLCs](https://developer.karmacheck.com/api-reference/services/get-all-cplcs.md): Retrieves the list of all professional licenses and certifications, including ones that are disabled for verification.
- [Get CPLC full definition](https://developer.karmacheck.com/api-reference/services/get-cplc-full-definition.md): Returns an object describing a specific professional license or certification.
- [Get CPLC full definitions for case](https://developer.karmacheck.com/api-reference/services/get-cplc-full-definitions-for-case.md): Retrieves a list of definitions for all the professional licenses and certifications that were provided to a case as testimony. This is used when rendering Professional License and Certification testimony by associating the testimony data with the definition.
- [Get CPLCs](https://developer.karmacheck.com/api-reference/services/get-cplcs.md): Retrieves the list of supported professional licenses and certifications that are enabled for verification.
- [Get mask list](https://developer.karmacheck.com/api-reference/services/get-mask-list.md): Retrieves a list of masks for the user to order new shipment.
- [Get users by group profile](https://developer.karmacheck.com/api-reference/users/get-users-by-group-profile.md): Gets the users for every group within the company that the authenticated user belongs to.
- [Search Verification Book](https://developer.karmacheck.com/api-reference/verification-book/search-verification-book.md): Search for Verification Book entries. Results will be returned by matching against the name and aliases of book items.
- [Candidate-provided PII flow](https://developer.karmacheck.com/background-check-api/guides/candidate-provided-pii-flow.md): Step-by-step guide for ordering a background check using the candidate-provided PII flow.
- [Customer-provided PII flow](https://developer.karmacheck.com/background-check-api/guides/customer-provided-pii-flow.md): Step-by-step guide for ordering a background check by providing the candidate's PII directly.
- [Document processing flow](https://developer.karmacheck.com/background-check-api/guides/document-processing-flow.md): Walk through a complete document processing order: upload documents, create an order, retrieve results, and handle webhook updates.
- [Getting started with MCP](https://developer.karmacheck.com/background-check-api/guides/mcp-get-started-guide.md): How to configure and use KarmaCheck's MCP server with Claude Desktop and Cursor.
- [Provide order data](https://developer.karmacheck.com/background-check-api/guides/order-data.md): Reference for all supported orderData types when creating a case or adding to an order.
- [Upload documents for a case](https://developer.karmacheck.com/background-check-api/guides/upload-documents.md): How to securely upload candidate disclosure and authorization documents and associate them with a case.
- [API basics](https://developer.karmacheck.com/background-check-api/overview/api/api-overview.md): An overview of the KarmaCheck REST API structure, endpoints, and request headers.
- [Authentication](https://developer.karmacheck.com/background-check-api/overview/api/authentication.md): How to obtain and use a JWT to authenticate KarmaCheck API requests.
- [Environments](https://developer.karmacheck.com/background-check-api/overview/api/environments.md): Staging and production environments, test SSNs, and simulated services for the KarmaCheck API.
- [Status codes and errors](https://developer.karmacheck.com/background-check-api/overview/api/errors.md): HTTP status codes used by the KarmaCheck API and the structure of error responses.
- [Case lifecycle](https://developer.karmacheck.com/background-check-api/overview/case-lifecycle.md): How a case moves through its states, from ordering through adjudication.
- [Changelog](https://developer.karmacheck.com/background-check-api/overview/changelog.md): Recent changes to the KarmaCheck API, in reverse chronological order.
- [Customer integration](https://developer.karmacheck.com/background-check-api/overview/customer-integration.md): How to enable KarmaCheck API access as a customer.
- [Glossary](https://developer.karmacheck.com/background-check-api/overview/glossary.md): Definitions of terms used throughout the KarmaCheck developer documentation.
- [Introduction](https://developer.karmacheck.com/background-check-api/overview/introduction.md): An overview of the KarmaCheck API and its integration scenarios.
- [Partner integration](https://developer.karmacheck.com/background-check-api/overview/partner-integration.md): How to register as a KarmaCheck API partner and access the system on behalf of mutual customers.
- [Case data statuses](https://developer.karmacheck.com/background-check-api/reference/case-data-status.md): System-defined IDs for all case data (service-level) statuses and pending statuses.
- [Case-level result and statuses](https://developer.karmacheck.com/background-check-api/reference/case-status.md): System-defined IDs for all case result types, primary statuses, secondary statuses, and adverse action statuses.
- [Professional license and certification](https://developer.karmacheck.com/background-check-api/reference/cplc.md): Supported CPLC types and their IDs for use in order data.
- [Invitation status](https://developer.karmacheck.com/background-check-api/reference/invitation-status.md): System-defined IDs for all invitation statuses.
- [Order configuration](https://developer.karmacheck.com/background-check-api/reference/order-configuration.md): Configuration properties for controlling how services are executed when creating a case.
- [Reason code for OHS and drug tests](https://developer.karmacheck.com/background-check-api/reference/reason-code.md): System-defined IDs for all reason codes used with OHS and drug screening services.
- [Secure document type](https://developer.karmacheck.com/background-check-api/reference/secure-document-type.md): System-defined IDs for all supported secure document types.
- [Service](https://developer.karmacheck.com/background-check-api/reference/service.md): Complete list of all orderable KarmaCheck services and their IDs, organised by service type.
- [Service type and categories](https://developer.karmacheck.com/background-check-api/reference/service-type.md): System-defined IDs for all service types, categories, and subcategories.
- [Testimony type](https://developer.karmacheck.com/background-check-api/reference/testimony-type.md): System-defined IDs for all testimony types.
- [Case data status change](https://developer.karmacheck.com/background-check-api/reference/webhooks/events/case-data-status-change.md): Webhook event payload and properties for the casedata.statuschange event.
- [Case status change](https://developer.karmacheck.com/background-check-api/reference/webhooks/events/case-status-change.md): Webhook event payload and properties for the case.statuschange event.
- [Webhooks](https://developer.karmacheck.com/background-check-api/reference/webhooks/webhooks-overview.md): How to subscribe to and handle KarmaCheck webhook events.