> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkr

> How to set up the Checkr connector, plus the actions that are available.

![Checkr](https://stackone-logos.com/api/checkr/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/checkr/changelog.md)

[67 actions](#actions) · 2 auth methods

Background Checks
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/checkr/guides/connector-profile/api-key.md)
>
> Uses HTTP Basic Auth with an API key as the username and an empty password. API keys are environment-specific (productio...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/checkr/guides/connector-profile/oauth-2-0.md)
>
> For Checkr partners. Requires a Partner Application from Checkr. Tokens are account-level and do not expire.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/checkr/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/checkr/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

67 actions

ActionDescription

Create Candidate`checkr_create_candidate`

Create a new candidate record in Checkr with contact details, identification, and address information for background che...

List Candidates`checkr_list_candidates`

Retrieve a paginated list of existing candidates with optional filtering by email, name, adjudication, custom ID, and da...

Get Candidate`checkr_get_candidate`

Retrieve an existing candidate by ID, optionally embedding related reports and geos.

Update Candidate`checkr_update_candidate`

Update an existing candidate's details. After a report has been ordered, only null-valued fields and certain always-upda...

Delete Candidate PII`checkr_delete_candidate_pii`

Request the removal of personally identifiable information (PII) from an existing candidate.

Create Report`checkr_create_report`

Create a new background check report for a candidate using a specified package. Use list\_packages to discover available...

Get Report`checkr_get_report`

Retrieve an existing report by ID, optionally embedding related screening sub-resources.

Update Report`checkr_update_report`

Update the package or adjudication of an existing report.

Complete Report`checkr_complete_report`

Cancel all pending or suspended screenings within a report and force-mark it as complete. This is destructive — it stops...

Get Report ETA`checkr_get_report_eta`

Retrieve the estimated completion date (ETA) for a report. Returns when the report is expected to finish processing — no...

List Packages`checkr_list_packages`

Retrieve a paginated list of existing background check packages.

Get Package`checkr_get_package`

Retrieve an existing background check package by ID.

Delete Package`checkr_delete_package`

Delete an existing background check package by ID.

Create Invitation`checkr_create_invitation`

Create a new invitation to send a candidate an email to submit their information for a background check. Use list\_packag...

List Invitations`checkr_list_invitations`

Retrieve a paginated list of existing invitations with optional filtering by candidate ID or status.

Get Invitation`checkr_get_invitation`

Retrieve an existing invitation by ID.

Cancel Invitation`checkr_cancel_invitation`

Cancel an existing invitation by ID.

Get SSN Trace`checkr_get_ssn_trace`

Retrieve an SSN Trace screening result by ID. Use get\_report first to extract the ssn\_trace\_id from the report response.

Get National Criminal Search`checkr_get_national_criminal_search`

Retrieve a National Criminal Search screening result by ID. Use get\_report first to extract the national\_criminal\_search...

Get County Criminal Search`checkr_get_county_criminal_search`

Retrieve a County Criminal Search screening result by ID. Use get\_report first to extract the county\_criminal\_search\_ids...

Get State Criminal Search`checkr_get_state_criminal_search`

Retrieve a State Criminal Search screening result by ID. Use get\_report first to extract the state\_criminal\_search\_ids f...

Get Federal Criminal Search`checkr_get_federal_criminal_search`

Retrieve a Federal Criminal Search screening result by ID. Use get\_report first to extract the federal\_criminal\_search\_i...

Get Sex Offender Search`checkr_get_sex_offender_search`

Retrieve a Sex Offender Registry Search screening result by ID. Use get\_report first to extract the sex\_offender\_search\_...

Get Global Watchlist Search`checkr_get_global_watchlist_search`

Retrieve a Global Watchlist Search screening result by ID. Use get\_report first to extract the global\_watchlist\_search\_i...

Get Motor Vehicle Report`checkr_get_motor_vehicle_report`

Retrieve a Motor Vehicle Report screening result by ID. Use get\_report first to extract the motor\_vehicle\_report\_id from...

Get Education Verification`checkr_get_education_verification`

Retrieve an Education Verification screening result by ID. Use get\_report first to extract the education\_verification\_id...

Get Employment Verification`checkr_get_employment_verification`

Retrieve an Employment Verification screening result by ID. Use get\_report first to extract the employment\_verification\_...

Get Drug & Alcohol Clearinghouse Search`checkr_get_drug_alcohol_clearinghouse_search`

Retrieve a Drug & Alcohol Clearinghouse Search screening result by ID. Use get\_report first to extract the drug\_alcohol\_...

Get FACIS Search`checkr_get_facis_search`

Retrieve a FACIS (Fraud and Abuse Control Information System) Search screening result by ID. Use get\_report first to ext...

Create Adverse Action`checkr_create_adverse_action`

Create a new adverse action for a report, initiating the pre-adverse action notice process. Use list\_adverse\_items first...

List Adverse Actions`checkr_list_adverse_actions`

Retrieve all formal adverse action notices associated with a report. These are the official pre/post adverse action reco...

Get Adverse Action`checkr_get_adverse_action`

Retrieve an existing adverse action by ID.

Cancel Adverse Action`checkr_cancel_adverse_action`

Cancel an existing adverse action by ID.

List Adverse Items`checkr_list_adverse_items`

List individual flagged records (adverse items) from a report's screenings. These are specific findings that can be sele...

Create Subscription`checkr_create_subscription`

Create a new repeating background check subscription for a candidate on a defined interval. Use list\_packages to discove...

List Subscriptions`checkr_list_subscriptions`

Retrieve a paginated list of existing subscriptions with optional filtering.

Get Subscription`checkr_get_subscription`

Retrieve an existing subscription by ID.

Update Subscription`checkr_update_subscription`

Update an existing subscription's settings.

Cancel Subscription`checkr_cancel_subscription`

Cancel an existing subscription by ID.

Create Continuous Check`checkr_create_continuous_check`

Create a new continuous check enrollment for a candidate to enable ongoing criminal or MVR monitoring.

List Continuous Checks`checkr_list_continuous_checks`

List existing continuous checks for a candidate.

Get Continuous Check`checkr_get_continuous_check`

Retrieve an existing continuous check by ID.

Update Continuous Check`checkr_update_continuous_check`

Update an existing continuous check's node or work locations.

Cancel Continuous Check`checkr_cancel_continuous_check`

Cancel an existing continuous check by ID.

Create Webhook`checkr_create_webhook`

Create a new webhook endpoint to receive event notifications from Checkr.

List Webhooks`checkr_list_webhooks`

Retrieve a list of existing webhooks for the authenticated account.

Get Webhook`checkr_get_webhook`

Retrieve an existing webhook by ID.

Delete Webhook`checkr_delete_webhook`

Delete an existing webhook by ID.

List Candidate Documents`checkr_list_documents`

List all documents for a candidate, optionally filtered by document type.

Upload Candidate Document`checkr_upload_document`

Upload a new document for a candidate.

Get Document`checkr_get_document`

Retrieve a document by ID, including a time-limited download URL.

List Verifications`checkr_list_verifications`

List existing verifications for a report.

Get Verification`checkr_get_verification`

Retrieve an existing verification by ID. Use list\_verifications with a report\_id first to discover verification IDs.

Get Account`checkr_get_account`

Retrieve authenticated account details.

List Users`checkr_list_users`

Retrieve a paginated list of all existing users on the account.

List Counties`checkr_list_counties`

Get counties by state(s) for county criminal search configuration.

Add Report Tag`checkr_add_report_tag`

Add a tag to a report, returning the updated list of all tags for that report.

List Report Tags`checkr_list_report_tags`

Retrieve all tags currently associated with a report.

List Report Addresses`checkr_list_report_addresses`

Retrieve all addresses associated with a report.

List Programs`checkr_list_programs`

Retrieve a paginated list of programs configured for your account.

Get Program`checkr_get_program`

Retrieve an existing program by ID.

List Geos`checkr_list_geos`

Retrieve a paginated list of geographic locations (geos) configured for your account.

Get Unified Credentials`checkr_unified_get_me`

Get the current Checkr connection's unified credentials and identity.

List Unified Organizations`checkr_unified_list_organizations`

List unified organizations in Checkr.

Get Unified Organization`checkr_unified_get_organization`

Get a unified Checkr organization by ID.

List Unified Users`checkr_unified_list_users`

List unified dashboard users in Checkr.

Get Unified User`checkr_unified_get_user`

Get a unified Checkr dashboard user by ID.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.