Skip to main content
Checkr
Checkr
62 actions · 1 auth method
BetaATS

Authentication

API Key

Uses HTTP Basic Auth with an API key as the username and an empty password. API keys are environment-specific (productio…Guides: Connector Profile, Link Account
Actions
62 actions
Action
Description
Create Candidate
Create a new candidate record in Checkr with contact details, identification, and address information for background che…
List Candidates
Retrieve a paginated list of existing candidates with optional filtering by email, name, adjudication, custom ID, and da…
Get Candidate
Retrieve an existing candidate by ID, optionally embedding related reports and geos.
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
Request the removal of personally identifiable information (PII) from an existing candidate.
Create Report
Create a new background check report for a candidate using a specified package. Use list_packages to discover available…
Get Report
Retrieve an existing report by ID, optionally embedding related screening sub-resources.
Update Report
Update the package or adjudication of an existing report.
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
Retrieve the estimated completion date (ETA) for a report. Returns when the report is expected to finish processing — no…
List Packages
Retrieve a paginated list of existing background check packages.
Get Package
Retrieve an existing background check package by ID.
Delete Package
Delete an existing background check package by ID.
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
Retrieve a paginated list of existing invitations with optional filtering by candidate ID or status.
Get Invitation
Retrieve an existing invitation by ID.
Cancel Invitation
Cancel an existing invitation by ID.
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
Retrieve a National Criminal Search screening result by ID. Use get_report first to extract the national_criminal_search…
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
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
Retrieve a Federal Criminal Search screening result by ID. Use get_report first to extract the federal_criminal_search_i…
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
Retrieve a Global Watchlist Search screening result by ID. Use get_report first to extract the global_watchlist_search_i…
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
Retrieve an Education Verification screening result by ID. Use get_report first to extract the education_verification_id…
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
Retrieve a Drug & Alcohol Clearinghouse Search screening result by ID. Use get_report first to extract the drug_alcohol_…
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
Create a new adverse action for a report, initiating the pre-adverse action notice process. Use list_adverse_items first…
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
Retrieve an existing adverse action by ID.
Cancel Adverse Action
Cancel an existing adverse action by ID.
List Adverse Items
List individual flagged records (adverse items) from a report’s screenings. These are specific findings that can be sele…
Create Subscription
Create a new repeating background check subscription for a candidate on a defined interval. Use list_packages to discove…
List Subscriptions
Retrieve a paginated list of existing subscriptions with optional filtering.
Get Subscription
Retrieve an existing subscription by ID.
Update Subscription
Update an existing subscription’s settings.
Cancel Subscription
Cancel an existing subscription by ID.
Create Continuous Check
Create a new continuous check enrollment for a candidate to enable ongoing criminal or MVR monitoring.
List Continuous Checks
List existing continuous checks for a candidate.
Get Continuous Check
Retrieve an existing continuous check by ID.
Update Continuous Check
Update an existing continuous check’s node or work locations.
Cancel Continuous Check
Cancel an existing continuous check by ID.
Create Webhook
Create a new webhook endpoint to receive event notifications from Checkr.
List Webhooks
Retrieve a list of existing webhooks for the authenticated account.
Get Webhook
Retrieve an existing webhook by ID.
Delete Webhook
Delete an existing webhook by ID.
List Candidate Documents
List all documents for a candidate, optionally filtered by document type.
Upload Candidate Document
Upload a new document for a candidate.
Get Document
Retrieve a document by ID, including a time-limited download URL.
List Verifications
List existing verifications for a report.
Get Verification
Retrieve an existing verification by ID. Use list_verifications with a report_id first to discover verification IDs.
Get Account
Retrieve authenticated account details.
List Users
Retrieve a paginated list of all existing users on the account.
List Counties
Get counties by state(s) for county criminal search configuration.
Add Report Tag
Add a tag to a report, returning the updated list of all tags for that report.
List Report Tags
Retrieve all tags currently associated with a report.
List Report Addresses
Retrieve all addresses associated with a report.
List Programs
Retrieve a paginated list of programs configured for your account.
Get Program
Retrieve an existing program by ID.
List Geos
Retrieve a paginated list of geographic locations (geos) configured for your account.

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/checkr/filled/png

Connector Profile

Checkr - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/checkr/filled/png

Link Account

Checkr - API Key
4

Use Actions

Invoke actions using one of the methods below: