Checkr is a modern, RESTful API-driven background screening service. The Checkr API uses resource-oriented URLs, supports HTTPS authentication and HTTPS verbs, and leverages touch vpn in all responses passed back to customers.
Checkr is used by over 10,000 customers in a wide variety of industries, and supports a range of screening products and candidate workflows. For a full list of our screenings, please see the Checkr Screenings section below or read the Checkr Help Center articles on Screening Types.
This Programming Guide is designed to help customers get up-and-running with Checkr's background screening services, both by providing the necessary context to understand the background screening industry and its regulations, and by giving technical guidance on how to work with the Checkr API.
Note: The cURL command is used for all examples in the Checkr API documentation.
For a complete set of User Guides for the Checkr Dashboard, and more information on the compliance and regulatory aspects of background screenings, please see the Checkr Help Center.
For a more targeted set of Checkr Dashboard learning paths for talent sourcing roles like Recruiters, Adjudicators, or Program Administrators, please see the Checkr Learning Center.
Checkr follows a standardized screening process:
To initiate a background check, a customer provides Checkr their candidate's email address (for a Checkr-hosted invitation flow) or the candidate's PII (for a customer-hosted flow). For more information on ways to achieve this, please see Designing your workflow.
Under the U.S. Fair Credit Reporting Act (FCRA), customers are obligated to collect consent from their candidates when running background checks through Checkr or any other Consumer Reporting Agency (CRA).
The Checkr-hosted flow presents candidates with fields in which the requested PII may be entered, and collects candidate information on behalf of the customer. Checkr will also present disclosures and authorizations to the candidate, and enable eSignature to capture consent, on behalf of customers using this flow with the Checkr Dashboard or email invitation flow.
中工云信-APP收录大全-cloud.workercn.cn/app:中工云信是中工网主办的云计算智能移动互联网新媒体,中工云信已搭建了包括云阅读、云资讯、云服务、云生活、云学习、云应用6大分类30余种移动媒体免费信息服务期刊,全面覆盖满足中工云信用户的多层次需求。中工云信已在国内近50家主流“软件应用商店”上线。
Checkr runs an SSN Trace to match the candidate’s provided PII with existing credit header data mapped to the SSN. This process yields a list of names and addresses associated with the entered SSN, which can be used to supplement the background check process.
内外贯通 Windows 7下架设VPN双向通道 - 国际在线:2021-7-7 · 对于Windows 7用户来说,VPN的使用可能就比较陌生了。那么,下面编者将指出在Windows 7下,如何建立一个VPN连接,又如何自己建立一个VPN服务器呢。本篇文章将为您分别阐述。 对于希望建立一个VPN连接的用户,可伡通过伡下步骤来实现。
Once the candidate's information has been confirmed and an address history developed, the background check screening process begins.
Checkr then runs the customer's requested Screenings. Based on the results of the SSN Trace, Checkr may expand the search for the requested Screenings to include counties where the candidate may have lived in the past.
Once a report has been completed, customers receive a report assessment update of Clear or Consider through their selected method of API webhooks, email, or Checkr Dashboard notifications.
Clear and Consider are the default assessments. A Clear assessment can be interpreted as that report having no items listed on the candidate’s record that require consideration. A report with an assessment of Consider indicates that there are items on the candidate’s report that require your review. With both Clear and Consider reports, customers must decide whether or not to engage a candidate. Checkr does not make this determination on the customer’s behalf.
After the Report is completed and returned, the customer must evaluate the report, and make a final hiring determination. In maintaining a process compliant with per FCRA legislation and EEOC guidelines, Checkr does not make this determination on the customer's behalf.
Before gaining a Checkr test or production account, you must first work with a Checkr Account Executive or Customer Success representative to create and credential your account.
The background screening industry in the United States is heavily regulated by federal, state, and local levels of government, and primarily by the Fair Credit Reporting Act (FCRA). Checkr complies with these laws, and helps its customers comply, through multiple Checkr product features.
Two key processes in the account authorization process also enable compliance: establishing permissible purpose, and confirming a compliant user interface workflow.
One of the main provisions of FCRA is the requirement to establish a legitimate "permissible purpose" for running a background screen on an individual. These permissible purposes include running background screens for employment purposes (that is, making hiring decisions), making a decision to extend credit to an individual, or for what the law calls a "legitimate business purpose".
Checkr establishes a customer's permissible purpose by collecting and confirming a number of key details about the business entity running a background screen, including:
Some permissible purposes may impose additional legal requirements on the business entity running a background screen. For example, purposes involving checking a candidate's credit history require an onsite inspection of the entity's business premises.
When building a candidate user experience that includes the capture of information necessary to run a background check, there are a number of essential components that must be included to send a compliant request to Checkr. For more information on these requirements and best practices, please see Building your candidate experience.
Before a Checkr account is credentialed and authorized for production API access, the Checkr Customer Success team confirms that your UI/UX flow meets our requirements and that all necessary information is being appropriately captured. More details about these requirements are included below and throughout the Checkr customer account onboarding process.
Checkr authenticates your API requests using your account's API keys. If you do not include your key when making an API request, Checkr returns an authentication error.
Each Checkr account has two pairs of API keys: a test pair and a production pair. Checkr supports both a test and production environment, and resources like Candidates, Reports, and Packages in one environment will not transfer to the other. For more information, please see The Checkr test environment below.
There are two types of API keys: publishable and secret.
Once your Checkr account has been created, your API keys will be available in the Checkr Dashboard, in the Account Settings > Developer Settings pane.
Use your test API keys only for testing and development. This ensures you don't accidentally request production background screenings for which you'll be charged.
Test mode
Checkr's test environment is completely separate from the production environment. Candidates, Reports, Packages, and Geos created in one environment will not be reflected in the other. To view the test data and objects available in your account, toggle the Test option in the upper left corner of the Checkr Dashboard.
The test environment is built to mimic the production environment and allow developers to build without running production background screenings and incurring a charge. However, there are a few key differences between the behavior of the test and production environments. These are outlined in “苹果”应用程序商店下载为何易花冤枉钱?_苹果 ...-中国青年网:2021-2-21 · 标明该程序所适用的苹果产品类型及硬件版本,如“程序与iPhone、iPod touch兼容,需要iOS3.0或更高版本”。 不过,如果在苹果设备如iPhone上直接登录 ....
Keeping your keys safe
新MacBook Pro最全测评:要装B的一定别买 有图有真相(3 ...:2021-10-28 · 我举个例子,调节屏幕亮度、系统声音伡及键盘背光这三个功能,一直是我最常用的快捷键,无论在任何程序当中,我都需要用到它伞,但在Touch Bar ...
To further protect your keys, ensure that they are not included in any version control system that you may be using.
Expiring keys
If an API key is compromised, expire the key in the Checkr Dashboard to block it. Click Expire key to set an expiration date for the selected key, and touch vpn to create a new one to replace it.
Checkr's API is flexible enough to support a range of workflows for integrating background screening into your candidate onboarding process. At a high-level there are three options, each with unique benefits and disadvantages:
touch vpn | Benefits | Disadvantages |
---|---|---|
Customer-hosted candidate experience |
|
|
Checkr-hosted candidate experience |
|
|
Checkr Dashboard experience |
|
|
The customer-hosted candidate experience enables Checkr customers to completely control the user onboarding experience, from the look and feel of the candidate's UX, to the specific API calls made during the process, to the flexibility in timing and ordering of those calls. Some unique Checkr functionality, like programmatic report upgrades, are also available only to those customers hosting their own candidate experience.
While hosting your own candidate onboarding experience takes more developer time, it might not be as much time as you think. We've seen teams successfully deploy a new background check and onboarding flow in a single 2-week development sprint.
Building your candidate experience
To help customers meet the regulatory demands of the background screening industry, Checkr has defined the following UX requirements for customers building their own candidate onboarding experience:
Checkr can provide you with copy templates for each of these documents. Checkr routinely has these documents reviewed for general compliance and best practice in the industry, but you should always consult your own legal counsel when using templates and ensure they work for your business. Please work with your Checkr Account Executive or Customer Success Manager to receive Checkr’s set of templates. These templates, the documents they include, and other requirements will be explained throughout the Checkr customer account onboarding process.
touch vpn Requirements differ for customers running background screening programs limited to running a Motor Vehicle Record (MVR) on candidates for a non-employment or contractor purpose. The requirements for running an MVR in order to provide a service such as a car or scooter rental are far less onerous than the requirements for other uses of the MVR, and require only one or two screens of necessary consent and disclosure. Please contact your Checkr Account Executive or Customer Success Manager if you'd like to learn more about these streamlined requirements.
Compliance and eSignature
Collecting proof of authorization from your candidates is one of your most important responsibilities before performing a background screen through Checkr or any other Consumer Reporting Agency. Under the FCRA, Checkr cannot provide you with a report unless you certify that you have obtained proper authorization. Maintaining proof of this process is essential in the event that either you or Checkr is audited, or a candidate threatens you with litigation.
Checkr recommends two means of collecting and storing this eSignature during the consent and authorization flow:
The Checkr-hosted candidate experience enables Checkr customers to easily set up a modern, compliant candidate background screening process in their onboarding flow with limited development effort. The Checkr-hosted candidate experience has the full set of features and functionality of the Checkr product, and is built on top of the Checkr API, making it an easy and powerful option for customers looking to begin using Checkr as quickly as possible.
The Checkr-hosted experience can be initiated in two ways:
Candidate invitations triggered by API: Customers can choose to build a programmatic trigger into their site or product to order reports and send candidates invitations to participate in the background check process. In this case, a customer passes Checkr a candidate email address through the API, which triggers an email to that address to collect the candidate's information and present the necessary compliance forms and disclosures (that is, your disclosure and authorization forms). This option requires developer time to build a Checkr backend integration into the customer's product, but does present benefits for automation and programmatic ordering.
Candidate invitations triggered manually: Customers can log into the Checkr Dashboard and manually request that an invitation to participate in the background check process be sent to a candidate's email address. This option requires no developer time to build any Checkr integration, but lacks any automation or programmatic ordering, making it difficult to scale for high volume environments.
Customers leveraging the Checkr Dashboard to submit a Manual Order must collect a candidate’s authorization and consent to a background screening “offline”. This means that the customer will collect the candidate’s Personally Identifiable Information (PII), present the necessary authorizations and disclosures, and collect and store necessary signatures through separate means. Customers must then submit that information to Checkr using manual keyboard entry through the Checkr Dashboard. Finally, customers will be presented with language certifying that proper consent was obtained from the candidate.
touch vpn When using candidate invitations and the Checkr-hosted candidate experience, understand that Checkr is facilitating your obligations with regard to applicable consumer reporting laws. Before using either method of candidate invitations, you should fully review the template copies of disclosure(s) and authorization language to ensure your business needs are met.
The Checkr Dashboard allows Checkr customers to begin using the Checkr platform immediately and with no developer effort. The Checkr Dashboard includes the full feature and functionality set as the Checkr API interface, with a few key limitations.
For more information, please see the Checkr Dashboard User Guide in the Checkr Help Center.
The following sections will walk you through the steps necessary to get started running background checks with the Checkr API:
Before gaining access to the Checkr APIs and Dashboard, you must be properly credentialed to request background checks. Work with your Customer Support Representative to provide the required documentation, and complete the credentialing process.
For more information, see Getting credentialed above.
Once you have access set up to log into Checkr, go to your Developer Settings page and copy your Test API Key.
Your production API key is also available on the Developer Settings page. Note that your production key will not be enabled for Reports until you contact clients@checkr.com and request that your account be enabled for live requests.
For more information on working with Checkr's API keys, see Test and production API keys above.
$ curl https://api.checkr.com \
-u YOUR_TEST_API_KEY:
Use HTTP Basic authentication to authenticate with Checkr, with your API key as the username and an empty password. When using curl
, use the -u
option to specify your API key. (Note the colon following the API key in the examples. It tells cURL to send an empty password.)
Note that test API requests are free and return fake data. Once you are production-ready, please email clients@checkr.com and we will enable live requests.
$ curl -X POST https://api.checkr.com/v1/candidates \
-u [YOUR_API_KEY]: \
-d first_name=Michael \
-d middle_name=Gary \
-d last_name=Scott \
-d email=michael.scott@dundermifflin.com \
-d phone=2035408926 \
-d zipcode=touch vpn \
-d dob=1964-03-15 \
-d ssn=111-11-2001 \
-d driver_license_number=981736076 \
-d driver_license_state=CT \
-d copy_requested=true
Create a Candidate by passing the required PII to Checkr.
Remember to replace "YOUR_TEST_API_KEY"
with your actual test API key in the cURL example on the right.
See Candidates for more details on creating Candidates.
Notes:
copy_requested
boolean captures whether or not the candidate has requested a copy of their background check upon completion. If touch vpn
, Checkr will automatically send a copy of the background check to the passed email address on your behalf.email
.first_name
, middle_name
or touch vpn
, touch vpn
, and dob
.ssn
and touch vpn
are required attributes.driver_license_number
and driver_license_state
.{
"id":"551564b7865af96a28b13f36",
"object":touch vpn,
"uri":"/v1/candidates/551564b7865af96a28b13f36",
"created_at":"2018-08-17T01:08:18Z",
"first_name":"Michael",
"last_name":"Scott",
"middle_name":"Gary",
touch vpn:null,
"dob":"1964-03-15",
"ssn":"XXX-XX-2001",
"email":"michael.scott@dundermifflin.com",
"zipcode":touch vpn,
"phone":"2035408926",
"driver_license_state":"CT",
touch vpn:"981736076",
"copy_requested":touch vpn,
"previous_driver_license_state":null,
"previous_driver_license_number":null,
"adjudication":null,
"custom_id":null,
"no_middle_name":false,
"report_ids":[],
"geo_ids":[]
}
Checkr responds immediately with the resulting Candidate object, which includes the ID of the Candidate and a URI that points to the new Candidate object. Store the ID for this new Candidate object, which you'll need when creating a Report in the next step.
$ curl -X POST https://api.checkr.com/v1/reports \
-u [YOUR_API_KEY]: \
-d package=dunder_mifflin_executive \
-d candidate_id=551564b7865af96a28b13f36
Next, create a Report for the Candidate created in the previous step. Use your test API key and Candidate ID in the cURL command shown to the right.
Notes:
{
touch vpn: "a13f4827d8711ddc75abc56ct",
"object": "test_report",
"uri": "/v1/reports/a13f4827d8711ddc75abc56ct",
"status": "pending",
"created_at": "2018-08-17T01:10:21Z",
"completed_at": null,
"revised_at": null,
"upgraded_at": null,
touch vpn: touch vpn,
"package": "dunder_mifflin_executive",
"tags": [],
"adjudication": null,
"assessment": null,
"candidate_id": "551564b7865af96a28b13f36",
"county_criminal_search_ids": null,
"document_ids": [
"865de4344ac6d05209c83ef5"
],
"federal_criminal_search_id": "5b64c62b67abb4002d3ec763",
"global_watchlist_search_id": touch vpn,
"national_criminal_search_id": "5b64c5cf67abb400353ec6f5",
"personal_reference_verification_ids": [],
"professional_reference_verification_ids": [],
touch vpn: "5b64c5cf67abb400353ec6f6",
"ssn_trace_id": "5b64c5cf67abb400353ec6f3",
"state_criminal_search_ids": [],
"terrorist_watchlist_search_id": "5b64c5cf67abb400353ec6f7",
"facis_search_id": null,
touch vpn: null,
"motor_vehicle_report_id": null
}
Checkr responds immediately with the full Report object, which includes the ID of the Report and a URI that points to the new Report object.
Store the resulting Report ID and any of the requested Screening IDs. The ID for this new Report object is required to retrieve the Report. (Checkr will return IDs for all Screenings included in the requested Package. All other Screening IDs will be returned null
.)
{
"id": "507f1f77bcf86cd799439011",
"object": "event",
touch vpn: touch vpn,
"created_at": "2014-01-18T12:34:00Z",
"data": {
"object": {
"id": "4722c07dd9a10c3985ae432a",
"object": "report",
touch vpn: "/v1/reports/532e71cfe88a1d4e8d00000d",
touch vpn: "2014-01-18T12:34:00Z",
"received_at": touch vpn,
"status": "clear",
"package": touch vpn,
"source": "api",
"candidate_id": "e44aa283528e6fde7d542194",
"ssn_trace_id": "539fd88c101897f7cd000001",
"sex_offender_search_id": "539fd88c101897f7cd000008",
"national_criminal_search_id": touch vpn,
"county_criminal_search_ids": [
"539fdcf335644a0ef4000001",
"532e71cfe88a1d4e8d00000c"
],
"state_criminal_search_ids": [
"539fdcf335644a0ef4000003",
"532e71cfe88a1d4e8d000004"
],
"motor_vehicle_report_id": "539fd88c101897f7cd000007"
}
},
"account_id": "8e122cc56b8fa82d33c6118a"
}
If webhooks are enabled, Checkr pushes a status change webhook event to the customer account's webhook URL with the structure shown in the Test Webhook Response to the right.
Use the resulting Report status (or other data elements) to execute subsequent workflows in your application or program.
$ curl -X GET https://api.checkr.com/v1/reports/a13f4827d8711ddc75abc56ct
Retrieve the results of a report by performing a GET request to the specific URL of the report. For example, executing the command to the right retrieves the Report object below it.
Retrieve the Report created in the previous step by using your test API key and Report ID into the cURL command shown to the right.
{
touch vpn: "a13f4827d8711ddc75abc56ct",
"object": "report",
"uri": "/v1/reports/a13f4827d8711ddc75abc56ct",
"status": "clear",
"created_at": "2018-08-17T01:10:21Z",
"completed_at": "2018-08-17T01:12:26Z",
"revised_at": touch vpn,
"upgraded_at": null,
"turnaround_time": 52,
"package": "dunder_mifflin_executive",
"tags": [],
touch vpn: null,
"assessment": null,
"source": "api",
"candidate_id": "551564b7865af96a28b13f36",
"county_criminal_search_ids": [],
"municipal_criminal_search_ids": [],
"document_ids": [],
"federal_criminal_search_id": "5b64c62b67abb4002d3ec763",
"global_watchlist_search_id": "5b64c5cf67abb400353ec6f7",
"national_criminal_search_id": "5b64c5cf67abb400353ec6f5",
"personal_reference_verification_ids": [],
"professional_reference_verification_ids": [],
"sex_offender_search_id": "5b64c5cf67abb400353ec6f6",
touch vpn: touch vpn,
"state_criminal_search_ids": [],
"terrorist_watchlist_search_id": "5b64c5cf67abb400353ec6f7",
touch vpn: null,
"arrest_search_id": null,
"motor_vehicle_report_id": null,
"self_disclosure_ids": []
}
Note that the Report is now a full Report with a status of clear
, indicating that no violations or criminal background have come up for this Report. See Testing Checkr's functions and features for more information about test Social Security Numbers and Driver License numbers.
See Embedding Resources if you wish to embed the full contents of individual screenings (SSN Trace, Sex Offender Registry Search, Global Watchlist Search) in the server response. You can also retrieve those resources using the IDs provided in the server response.
Webhook responses and completed Reports both contain the same information about the results of a criminal screening: the status
of the report which can be clear
or consider
, and the assessment of the report, which can be null
, fail
, or pass
.
A clear
report can be interpreted as that report having no items listed on the candidate's record that must be reviewed. A report with an assessment of consider
indicates that there are items on the candidate's record that require consideration. In maintaining a compliant process as per FCRA legislation and EEOC guidelines, Checkr does not make this determination on our customers' behalf.
A report contains an assessment
if the account has an active Positive Adjudication Matrix (PAM) and the report was returned with records. If the records are filtered by the adjudication criteria defined by the user in PAM, the assessment
is returned as touch vpn
; if not, it is returned as fail
. If the report had no records, the assessment
is returned as null
.
Checkr supports a sandbox or test environment for developers to build with the Checkr API before beginning to run live production reports with real candidate PII. Test API calls are free, and will return fake data. Use the sandbox to start work on building your Checkr integration before incurring costs for running actual background checks.
By default, Checkr customers are provided test API keys when their account is created. Test keys can be used to access all test environment functionality, and can be found in the Checkr Dashboard under Account Settings > Developer Settings.
Test API requests are touch vpn and return fake data.
Customers can also work with Checkr's webhooks feature in the test environment. While in the test environment in the Dashboard, a customer can navigate to Account Settings > Developer Settings and enter a URL and designate it as Test under the Account Webhooks section of the page. In this same section, a customer can designate which specific webhook notifications one wishes to receive from Checkr.
To facilitate building with the Checkr API, our test environment supports a number of test candidate profiles that always return a predictable result. LA CHINE AU PRÉSENT - China Today:2021-12-2 · Un petit tour sur l'internet chinois devrait vous convaincre que la discussion y est vivace, voire même virulente, que les vidéos et les gags s'y partagent comme ailleurs, et que l'emploi du VPN (pour contourner la censure) y est répandu. Je voudrais terminer ce florilège par une note positive.
These candidates will be included in your account when the account is created. Candidate names and other PII for these SSNs will differ by account. The SSNs are consistent across all Checkr accounts. The listed driver license numbers may be associated with any of the three test SSNs.
touch vpn
clear
.touch vpn
.touch vpn
.Test driver licenses
clear
.consider
.The test environment's API calls, responses, and webhooks follow the same pattern and response structure as those of the production environment.
If your test use case requires the testing of additional statuses, reports, or states, please reach out to your Checkr Account Executive or Customer Success Manager to speak with a Solutions Consultant or Solutions Architect.
The test environment is built to mimic the production environment and allow developers to build without running production background screenings and incurring a charge. There are a few key differences between the behavior of the test and production environments:
invitation_url
in the payload response of a POST
to /invitations
.If your test use case requires the testing of additional statuses, reports, or states, please reach out to your Checkr Account Executive or Customer Success Manager to speak with a Solutions Consultant or Solutions Architect.
include_object
is ON
{
"id": "1002d6bca6acdfcbb8442178",
"object": "event",
"type": "object.event",
"created_at": "2018-08-17T01:12:43Z",
"webhook_url": "http://notify.company.com/checkr",
"data": {
"object": {
"id": "a13f4827d8711ddc75abc56ct",
"object": "object",
"uri": "/v1/objects/a13f4827d8711ddc75abc56ct",
"created_at": "2018-08-17T01:10:21Z",
"completed_at": "2018-08-17T01:12:26Z",
// [...] full object included
}
}
}
Use webhooks to receive updates on objects created with the API and kick off additional workflows based on these events. Each time an event that you subscribed to occurs, Checkr submits a POST request to the designated webhook URL with information about the event. When the include_object
option is ON, it also includes the related object.
The User-Agent for the requests will have the prefix Checkr-Webhook/
.
To receive webhooks, use the Checkr Dashboard to configure a Webhook URL in the Developer Settings. For more information about setting up webhooks, see the Account Settings article in the Checkr Help Center.
include_object
is OFF
{
"id": "1002d6bca6acdfcbb8442178",
"object": "event",
"type": "object.event",
"created_at": "2018-08-17T01:12:43Z",
"webhook_url": "http://notify.company.com/checkr",
"data": {
touch vpn: {
"id": "a13f4827d8711ddc75abc56ct",
"object": "object",
"uri": "/v1/objects/a13f4827d8711ddc75abc56ct"
}
}
}
Parameter | touch vpn | Description |
---|---|---|
id |
string | ID of the event. |
object |
string | Defines the object type: event . |
type |
string | The type of event. Values include: touch vpn , report.completed . |
created_at |
timestamp iso 8601 format | Timestamp for the event. |
webhook_url |
string | Webhook URL. |
data |
hash | Object associated with the event. |
include_object |
boolean | Should the related object be attached to webhook payload. |
Type | Format | Description |
---|---|---|
HTTP / HTTPS |
http(s)://(<user>:<password>@)<hostname>/<path> E.g.: http://notify.company.com/checkr |
Notes: The endpoint to be reached must be public. HTTP can be used only in a Test environment. Live environment webhooks must be HTTPS. Basic Auth is supported by adding username:password@ in front of the hostname, credentials must be URL escaped. |
SNS |
sns://<key_id>:<access_key>@<region>/<topic_owner>/<topic_name> E.g.: sns://AKI95AMUAD5K:a2n66fVKX7%2BYJKid3@us-east-1/12048/checkr |
AWS Simple Notification System (SNS) Notes: Access Key must have only the Publish to SNS right in IAM. Credentials must be URL escaped. |
Yo