Checkr

App · 25 actions

Manage background-check candidates, invitations, reports, packages and locations in Checkr.

Actions

ActionWhat it does
Add report tagAdd report tag.
Cancel invitationCancel an invitation that has not yet been completed.
Create candidateCreate candidate.
Create invitationSend a background-check invitation to a candidate.
Get accountGet account.
Get candidateGet candidate.
Get geoGet geo.
Get invitationGet invitation.
Get nodeGet node.
Get packageGet package.
Get reportGet report.
Get report etaGet report eta.
List candidate documentsList candidate documents.
List candidate driver licensesList candidate driver licenses.
List candidate employersList candidate employers.
List candidate schoolsList candidate schools.
List candidatesList candidates.
List geosList geos.
List invitationsList invitations.
List nodesList nodes.
List packagesList packages.
List report tagsList report tags.
Remove report tagRemove report tag.
Replace report tagsReplace report tags.
Update candidateUpdate candidate.

Add report tag

Add report tag. Add a tag to a Report

Inputs

Report tag IDidtextRequired
Id.
Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 100.
TagtagtextRequired
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 IDidtextRequired
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 namefirst_nametext
Candidate’s first name.
Middle namemiddle_nametext
Candidate’s middle name. This field is required if `no_middle_name` is `false`.
No middle nameno_middle_nametrue/false
Required if no `middle_name` is provided. `true` if the candidate has no middle name.Default: false.
Last namelast_nametext
Candidate’s last name.
EmailemailtextRequired
Candidate’s email address.
Phonephonetext
Candidate’s phone number.
Zipcodezipcodetext
Candidate’s 5-digit zip code.
Dobdobdate
Candidate’s date of birth.
Custom IDcustom_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.
Metadatametadataobject
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 locationswork_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

PackagepackagetextRequired
`slug` of the associated package.
Candidatecandidate_idtextRequired
ID of the Candidate for whom the Invitation is created.
Nodenodetext
Required for hierarchy-enabled accounts. `custom_id` of the associated node.
Work locationswork_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.
Tagstagslist
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

CandidateidtextRequired
Id.
Includeincludetext
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

GeoidtextRequired
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 IDidtextRequired
Id.
Include deletedinclude_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

Customcustom_idtextRequired
Custom id.
Includeincludetext
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

PackageidtextRequired
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 IDidtextRequired
Id.
Includeincludetext
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 IDidtextRequired
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

Candidatecandidate_idtextRequired
Candidate id.
Typestypeslist
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

Candidatecandidate_idtextRequired
Candidate id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "count": 1,
    "data": [],
    "object": "list"
  }
}

List candidate employers

List candidate employers. List existing Employers

Inputs

Candidatecandidate_idtextRequired
Candidate id.
Pagepagenumber
Page.At least 1.
Per pageper_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

Candidatecandidate_idtextRequired
Candidate id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "next_href": "example",
    "object": "list"
  }
}

List candidates

List candidates. List existing Candidates

Inputs

Emailemailtext
Email.
Full namefull_nametext
Full name.
Adjudicationadjudicationtext
Adjudication.One of: engaged, pre_adverse_action (Pre adverse action), post_adverse_action (Post adverse action).
Custom IDcustom_idtext
Custom id.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.
Report adjudicated afterreport_adjudicated_afterdate and time
Report adjudicated after.
Report adjudicated beforereport_adjudicated_beforedate and time
Report adjudicated before.
Report adjudicator emailreport_adjudicator_emailtext
Report adjudicator email.
Report revised afterreport_revised_afterdate and time
Report revised after.
Report revised beforereport_revised_beforedate and time
Report revised before.
Driver license numberdriver_license_numbertext
Driver license number.
Geo IDgeo_idtext
Geo id.
Program IDprogram_idtext
Program id.
Pagepagenumber
Page.At least 1.
Per pageper_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

Namenametext
Name.
Statestatetext
State.
Pagepagenumber
Page.At least 1.
Per pageper_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

Candidatecandidate_idtext
Candidate id.
Statusstatustext
Status.One of: pending, completed, expired.
Pagepagenumber
Page.At least 1.
Per pageper_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

Includeincludetext
Include.One of: packages.
Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 100.
Order byorder_bytext
Order by.One of: custom_id (Custom id), created_at (Created at).
Orderordertext
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

Pagepagenumber
Page.At least 1.
Per pageper_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 IDidtextRequired
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 IDidtextRequired
Id.
TagtagtextRequired
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 IDidtextRequired
Id.
TagstagslistRequired
Tags.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "count": 1.0,
    "data": [],
    "object": "list"
  }
}

Update candidate

Update candidate. Update an existing Candidate

Inputs

CandidateidtextRequired
Id.
First namefirst_nametext
Candidate’s first name.
Middle namemiddle_nametext
Candidate’s middle name. This field is required if `no_middle_name` is `false`.
No middle nameno_middle_nametrue/false
Required if no `middle_name` is provided. `true` if the candidate has no middle name.Default: false.
Last namelast_nametext
Candidate’s last name.
Emailemailtext
Candidate’s email address.
Phonephonetext
Candidate’s phone number.
Zipcodezipcodetext
Candidate’s 5-digit zip code.
Dobdobdate
Candidate’s date of birth.
Custom IDcustom_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.
Metadatametadataobject
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"
  }
}

On this page