Checkr
App · 25 actions
Manage background-check candidates, invitations, reports, packages and locations in Checkr.
Actions
| Action | What it does |
|---|---|
| Add report tag | Add report tag. |
| Cancel invitation | Cancel an invitation that has not yet been completed. |
| Create candidate | Create candidate. |
| Create invitation | Send a background-check invitation to a candidate. |
| Get account | Get account. |
| Get candidate | Get candidate. |
| Get geo | Get geo. |
| Get invitation | Get invitation. |
| Get node | Get node. |
| Get package | Get package. |
| Get report | Get report. |
| Get report eta | Get report eta. |
| List candidate documents | List candidate documents. |
| List candidate driver licenses | List candidate driver licenses. |
| List candidate employers | List candidate employers. |
| List candidate schools | List candidate schools. |
| List candidates | List candidates. |
| List geos | List geos. |
| List invitations | List invitations. |
| List nodes | List nodes. |
| List packages | List packages. |
| List report tags | List report tags. |
| Remove report tag | Remove report tag. |
| Replace report tags | Replace report tags. |
| Update candidate | Update candidate. |
Add report tag
Add report tag. Add a tag to a Report
Inputs
- Report tag ID
idtextRequired - Id.
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
- Tag
tagtextRequired - Tag.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1.0,
"data": [],
"object": "list"
}
}Cancel invitation
Cancel an invitation that has not yet been completed.
Inputs
- Invitation ID
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"archived": false,
"archived_info": {
"time": "example",
"user": {
"email": "example",
"id": "example"
}
},
"candidate_id": "example",
"completed_at": "example",
"created_at": "example",
"deleted_at": "example",
"expires_at": "example",
"id": "example",
"invitation_url": "example",
"object": "invitation",
"package": "example",
"report_id": "example",
"status": "pending",
"uri": "example"
}
}Create candidate
Create candidate. Create a new Candidate
Inputs
- First name
first_nametext - Candidate’s first name.
- Middle name
middle_nametext - Candidate’s middle name. This field is required if `no_middle_name` is `false`.
- No middle name
no_middle_nametrue/false - Required if no `middle_name` is provided. `true` if the candidate has no middle name.Default:
false. - Last name
last_nametext - Candidate’s last name.
- Email
emailtextRequired - Candidate’s email address.
- Phone
phonetext - Candidate’s phone number.
- Zipcode
zipcodetext - Candidate’s 5-digit zip code.
- Dob
dobdate - Candidate’s date of birth.
- Custom ID
custom_idtext - Client-assigned unique ID for the Candidate. Can be used to map Checkr Candidate IDs to your internal tracking system, and to search for Candidates through both the Dashboard and the API.
- Metadata
metadataobject - Up to 50 customer-defined key-value pairs. Use this parameter to store additional information on your candidate. For example: Use the key to map candidates to `job_req_id`, `application_id`, or `branch_id`. Keys must be 40 characters or less. Values must be 500 characters or less. For example: { "job_req_id": "12345" }
- Work locations
work_locationslist - Required for non-US candidates. Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.
Outputs
dataobject- Response.
Example output
{
"data": {
"adjudication": "engaged",
"copy_requested": false,
"custom_id": "example",
"dob": "example",
"driver_license_number": "example",
"driver_license_state": "example",
"email": "example",
"first_name": "example",
"geo_ids": [],
"id": "example",
"last_name": "example",
"metadata": {},
"middle_name": "example",
"mother_maiden_name": "example",
"no_middle_name": false,
"object": "candidate",
"phone": "example",
"postal_address": {},
"previous_driver_license_number": "example",
"previous_driver_license_state": "example",
"report_ids": [],
"ssn": "example",
"uri": "example",
"zipcode": "example"
}
}Create invitation
Send a background-check invitation to a candidate. This emails the candidate and may incur screening charges.
Inputs
- Package
packagetextRequired - `slug` of the associated package.
- Candidate
candidate_idtextRequired - ID of the Candidate for whom the Invitation is created.
- Node
nodetext - Required for hierarchy-enabled accounts. `custom_id` of the associated node.
- Work locations
work_locationslist - Required for hierarchy-enabled accounts. Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.
- Tags
tagslist - Array of tags for the Report.
Outputs
dataobject- Response.
Example output
{
"data": {
"archived": false,
"archived_info": {
"time": "example",
"user": {
"email": "example",
"id": "example"
}
},
"candidate_id": "example",
"completed_at": "example",
"created_at": "example",
"deleted_at": "example",
"expires_at": "example",
"id": "example",
"invitation_url": "example",
"object": "invitation",
"package": "example",
"report_id": "example",
"status": "pending",
"uri": "example"
}
}Get account
Get account. Retrieve authenticated account details
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"account_deauthorization": {
"reason": "example"
},
"adverse_action_email": "example",
"api_authorized": false,
"authorized": false,
"available_screenings": [],
"billing_email": "example",
"company": {
"city": "example",
"dba_name": "example",
"incorporation_state": "example",
"incorporation_type": "association",
"industry": "example",
"name": "example",
"phone": "example",
"state": "example",
"street": "example",
"tax_id": "example",
"website": "example",
"zipcode": "example"
},
"compliance_contact_email": "example",
"created_at": "example",
"default_compliance_city": "example",
"default_compliance_state": "example",
"geos_required": false,
"id": "example",
"name": "example",
"object": "account",
"purpose": "employment",
"segmentation_enabled": false,
"support_email": "example",
"support_phone": "example",
"technical_contact_email": "example",
"uri": "example",
"uri_name": "example"
}
}Get candidate
Get candidate. Retrieve an existing Candidate
Inputs
- Candidate
idtextRequired - Id.
- Include
includetext - Include.One of:
reports,geos.
Outputs
dataobject- Response.
Example output
{
"data": {
"adjudication": "engaged",
"copy_requested": false,
"custom_id": "example",
"dob": "example",
"driver_license_number": "example",
"driver_license_state": "example",
"email": "example",
"first_name": "example",
"geo_ids": [],
"id": "example",
"last_name": "example",
"metadata": {},
"middle_name": "example",
"mother_maiden_name": "example",
"no_middle_name": false,
"object": "candidate",
"phone": "example",
"postal_address": {},
"previous_driver_license_number": "example",
"previous_driver_license_state": "example",
"report_ids": [],
"ssn": "example",
"uri": "example",
"zipcode": "example"
}
}Get geo
Get geo. Retrieve an existing Geo
Inputs
- Geo
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"city": "example",
"created_at": "example",
"deleted_at": "example",
"id": "example",
"name": "example",
"object": "geo",
"state": "example",
"uri": "example"
}
}Get invitation
Get invitation. Retrieve an existing Invitation
Inputs
- Invitation ID
idtextRequired - Id.
- Include deleted
include_deletedtrue/false - Include deleted.
Outputs
dataobject- Response.
Example output
{
"data": {
"archived": false,
"archived_info": {
"time": "example",
"user": {
"email": "example",
"id": "example"
}
},
"candidate_id": "example",
"completed_at": "example",
"created_at": "example",
"deleted_at": "example",
"expires_at": "example",
"id": "example",
"invitation_url": "example",
"object": "invitation",
"package": "example",
"report_id": "example",
"status": "pending",
"uri": "example"
}
}Get node
Get node. Retrieve an existing node
Inputs
- Custom
custom_idtextRequired - Custom id.
- Include
includetext - Include.One of:
packages.
Outputs
dataobject- Response.
Example output
{
"data": {
"custom_id": "example",
"name": "example",
"packages": [],
"parent_custom_id": "example",
"tier": "example"
}
}Get package
Get package. Retrieve an existing Package
Inputs
- Package
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"apply_url": "example",
"created_at": "example",
"deleted_at": "example",
"id": "example",
"name": "example",
"object": "package",
"price": 1,
"screenings": [],
"slug": "example",
"uri": "example"
}
}Get report
Get report. Retrieve an existing Report
Inputs
- Report ID
idtextRequired - Id.
- Include
includetext - Include.One of:
arrest_search(Arrest search),candidate,candidate_stories(Candidate stories),county_civil_searches(County civil searches),county_criminal_searches(County criminal searches),credit_report(Credit report),dispute_comments(Dispute comments),documents,drug_alcohol_clearinghouse(Drug alcohol clearinghouse),drug_screening(Drug screening), and 31 more.
Outputs
dataobject- Response.
Example output
{
"data": {
"adjudication": "engaged",
"archived": false,
"arrest_search_id": "example",
"assessment": "eligible",
"candidate_id": "example",
"candidate_story_ids": [],
"completed_at": "example",
"county_criminal_search_ids": [],
"created_at": "example",
"document_ids": [],
"drug_alcohol_clearinghouse_id": "example",
"drug_screening": {
"analytes": [],
"appointment_id": "example",
"disposition": "negative",
"events": [],
"id": "example",
"mro_notes": "example",
"result": "clear",
"screening_pass_expires_at": "example",
"status": "pending"
},
"drug_screening_id": "example",
"estimated_completion_time": "example",
"facis_search_id": "example",
"federal_civil_search_id": "example",
"federal_criminal_search_id": "example",
"federal_district_civil_search_id": "example",
"federal_district_criminal_search_id": "example",
"geo_ids": [],
"global_watchlist_search_id": "example",
"id": "example",
"includes_canceled": false,
"international_adverse_media_search_ids": [],
"international_criminal_searches_v2_ids": [],
"international_education_verification_id": "example",
"international_employment_verification_id": "example",
"international_global_watchlist_search_id": "example",
"international_identity_document_validation_id": "example",
"motor_vehicle_report_id": "example",
"national_criminal_search_id": "example",
"object": "report",
"occupational_health_screening_id": "example",
"package": "example",
"personal_reference_verification_ids": [],
"professional_license_verification_ids": [],
"professional_reference_verification_ids": [],
"program_id": "example",
"result": "clear",
"revised_at": "example",
"segment_stamps": [],
"sex_offender_search_id": "example",
"source": "api",
"ssn_trace_id": "example",
"state_criminal_searches": [],
"status": "pending",
"turnaround_time": 1,
"upgraded_at": "example",
"uri": "example",
"work_locations": []
}
}Get report eta
Get report eta. Retrieve a Report's ETA
Inputs
- Report eta ID
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"estimate_generated_at": "example",
"estimated_completion_time": "example"
}
}List candidate documents
List candidate documents. List a Candidate's Documents
Inputs
- Candidate
candidate_idtextRequired - Candidate id.
- Types
typeslist - Types.One or more of:
alien_id(Alien id),citizenship_certificate(Citizenship certificate),consent,credit_report_consent_form(Credit report consent form),degree,diploma,driver_license(Driver license),driver_license_back(Driver license back),driver_license_history(Driver license history),education_certificate(Education certificate), and 23 more.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"object": "list"
}
}List candidate driver licenses
List candidate driver licenses. List existing Driver Licenses
Inputs
- Candidate
candidate_idtextRequired - Candidate id.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"object": "list"
}
}List candidate employers
List candidate employers. List existing Employers
Inputs
- Candidate
candidate_idtextRequired - Candidate id.
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"object": "list"
}
}List candidate schools
List candidate schools. List existing Schools
Inputs
- Candidate
candidate_idtextRequired - Candidate id.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"next_href": "example",
"object": "list"
}
}List candidates
List candidates. List existing Candidates
Inputs
- Email
emailtext - Email.
- Full name
full_nametext - Full name.
- Adjudication
adjudicationtext - Adjudication.One of:
engaged,pre_adverse_action(Pre adverse action),post_adverse_action(Post adverse action). - Custom ID
custom_idtext - Custom id.
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Report adjudicated after
report_adjudicated_afterdate and time - Report adjudicated after.
- Report adjudicated before
report_adjudicated_beforedate and time - Report adjudicated before.
- Report adjudicator email
report_adjudicator_emailtext - Report adjudicator email.
- Report revised after
report_revised_afterdate and time - Report revised after.
- Report revised before
report_revised_beforedate and time - Report revised before.
- Driver license number
driver_license_numbertext - Driver license number.
- Geo ID
geo_idtext - Geo id.
- Program ID
program_idtext - Program id.
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"next_href": "example",
"object": "list",
"previous_href": "example"
}
}List geos
List geos. List existing Geos
Inputs
- Name
nametext - Name.
- State
statetext - State.
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"next_href": "example",
"object": "list",
"previous_href": "example"
}
}List invitations
List invitations. List existing Invitations
Inputs
- Candidate
candidate_idtext - Candidate id.
- Status
statustext - Status.One of:
pending,completed,expired. - Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"next_href": "example",
"object": "list",
"previous_href": "example"
}
}List nodes
List nodes. List existing Nodes
Inputs
- Include
includetext - Include.One of:
packages. - Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
- Order by
order_bytext - Order by.One of:
custom_id(Custom id),created_at(Created at). - Order
ordertext - Order.One of:
asc,desc.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"next_href": "example",
"object": "list",
"previous_href": "example"
}
}List packages
List packages. List existing Packages
Inputs
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 100.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1,
"data": [],
"next_href": "example",
"object": "list",
"previous_href": "example"
}
}List report tags
List report tags. Retrieve tags for a Report
Inputs
- Report tags ID
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1.0,
"data": [],
"object": "list"
}
}Remove report tag
Remove report tag. Delete a tag from a Report
Inputs
- Report tag ID
idtextRequired - Id.
- Tag
tagtextRequired - Tag.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1.0,
"data": [],
"object": "list"
}
}Replace report tags
Replace report tags. Update tags for a Report
Inputs
- Report tags ID
idtextRequired - Id.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Response.
Example output
{
"data": {
"count": 1.0,
"data": [],
"object": "list"
}
}Update candidate
Update candidate. Update an existing Candidate
Inputs
- Candidate
idtextRequired - Id.
- First name
first_nametext - Candidate’s first name.
- Middle name
middle_nametext - Candidate’s middle name. This field is required if `no_middle_name` is `false`.
- No middle name
no_middle_nametrue/false - Required if no `middle_name` is provided. `true` if the candidate has no middle name.Default:
false. - Last name
last_nametext - Candidate’s last name.
- Email
emailtext - Candidate’s email address.
- Phone
phonetext - Candidate’s phone number.
- Zipcode
zipcodetext - Candidate’s 5-digit zip code.
- Dob
dobdate - Candidate’s date of birth.
- Custom ID
custom_idtext - Client-assigned unique ID for the Candidate. Can be used to map Checkr Candidate IDs to your internal tracking system, and to search for Candidates through both the Dashboard and the API.
- Metadata
metadataobject - Up to 50 customer-defined key-value pairs. Use this parameter to store additional information on your candidate. For example: Use the key to map candidates to `job_req_id`, `application_id`, or `branch_id`. Keys must be 40 characters or less. Values must be 500 characters or less. For example: { "job_req_id": "12345" }
Outputs
dataobject- Response.
Example output
{
"data": {
"adjudication": "engaged",
"copy_requested": false,
"custom_id": "example",
"dob": "example",
"driver_license_number": "example",
"driver_license_state": "example",
"email": "example",
"first_name": "example",
"geo_ids": [],
"id": "example",
"last_name": "example",
"metadata": {},
"middle_name": "example",
"mother_maiden_name": "example",
"no_middle_name": false,
"object": "candidate",
"phone": "example",
"postal_address": {},
"previous_driver_license_number": "example",
"previous_driver_license_state": "example",
"report_ids": [],
"ssn": "example",
"uri": "example",
"zipcode": "example"
}
}