# Checkr

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/checkr

## Actions

### Add report tag

Add report tag. Add a tag to a Report

**Inputs**

- Report tag ID (`id`, text, required): Id.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.
- Tag (`tag`, text, required): Tag.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1.0,
    "data": [],
    "object": "list"
  }
}
```

### Cancel invitation

Cancel an invitation that has not yet been completed.

**Inputs**

- Invitation ID (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_name`, text): Candidate’s first name.
- Middle name (`middle_name`, text): Candidate’s middle name. This field is required if `no_middle_name` is `false`.
- No middle name (`no_middle_name`, true/false): Required if no `middle_name` is provided. `true` if the candidate has no middle name. Default: `false`.
- Last name (`last_name`, text): Candidate’s last name.
- Email (`email`, text, required): Candidate’s email address.
- Phone (`phone`, text): Candidate’s phone number.
- Zipcode (`zipcode`, text): Candidate’s 5-digit zip code.
- Dob (`dob`, date): Candidate’s date of birth.
- Custom ID (`custom_id`, text): 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 (`metadata`, object): 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_locations`, list): 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**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`package`, text, required): `slug` of the associated package.
- Candidate (`candidate_id`, text, required): ID of the Candidate for whom the Invitation is created.
- Node (`node`, text): Required for hierarchy-enabled accounts. `custom_id` of the associated node.
- Work locations (`work_locations`, list): 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 (`tags`, list): Array of tags for the Report.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.
- Include (`include`, text): Include. One of: `reports`, `geos`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.
- Include deleted (`include_deleted`, true/false): Include deleted.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_id`, text, required): Custom id.
- Include (`include`, text): Include. One of: `packages`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "custom_id": "example",
    "name": "example",
    "packages": [],
    "parent_custom_id": "example",
    "tier": "example"
  }
}
```

### Get package

Get package. Retrieve an existing Package

**Inputs**

- Package (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.
- Include (`include`, text): 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**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "estimate_generated_at": "example",
    "estimated_completion_time": "example"
  }
}
```

### List candidate documents

List candidate documents. List a Candidate's Documents

**Inputs**

- Candidate (`candidate_id`, text, required): Candidate id.
- Types (`types`, list): 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**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "object": "list"
  }
}
```

### List candidate driver licenses

List candidate driver licenses. List existing Driver Licenses

**Inputs**

- Candidate (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "object": "list"
  }
}
```

### List candidate employers

List candidate employers. List existing Employers

**Inputs**

- Candidate (`candidate_id`, text, required): Candidate id.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "object": "list"
  }
}
```

### List candidate schools

List candidate schools. List existing Schools

**Inputs**

- Candidate (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_href": "example",
    "object": "list"
  }
}
```

### List candidates

List candidates. List existing Candidates

**Inputs**

- Email (`email`, text): Email.
- Full name (`full_name`, text): Full name.
- Adjudication (`adjudication`, text): Adjudication. One of: `engaged`, `pre_adverse_action` (Pre adverse action), `post_adverse_action` (Post adverse action).
- Custom ID (`custom_id`, text): Custom id.
- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Report adjudicated after (`report_adjudicated_after`, date and time): Report adjudicated after.
- Report adjudicated before (`report_adjudicated_before`, date and time): Report adjudicated before.
- Report adjudicator email (`report_adjudicator_email`, text): Report adjudicator email.
- Report revised after (`report_revised_after`, date and time): Report revised after.
- Report revised before (`report_revised_before`, date and time): Report revised before.
- Driver license number (`driver_license_number`, text): Driver license number.
- Geo ID (`geo_id`, text): Geo id.
- Program ID (`program_id`, text): Program id.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "next_href": "example",
    "object": "list",
    "previous_href": "example"
  }
}
```

### List geos

List geos. List existing Geos

**Inputs**

- Name (`name`, text): Name.
- State (`state`, text): State.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "next_href": "example",
    "object": "list",
    "previous_href": "example"
  }
}
```

### List invitations

List invitations. List existing Invitations

**Inputs**

- Candidate (`candidate_id`, text): Candidate id.
- Status (`status`, text): Status. One of: `pending`, `completed`, `expired`.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "next_href": "example",
    "object": "list",
    "previous_href": "example"
  }
}
```

### List nodes

List nodes. List existing Nodes

**Inputs**

- Include (`include`, text): Include. One of: `packages`.
- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.
- Order by (`order_by`, text): Order by. One of: `custom_id` (Custom id), `created_at` (Created at).
- Order (`order`, text): Order. One of: `asc`, `desc`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1,
    "data": [],
    "next_href": "example",
    "object": "list",
    "previous_href": "example"
  }
}
```

### List packages

List packages. List existing Packages

**Inputs**

- Page (`page`, number): Page. At least 1.
- Per page (`per_page`, number): Per page. From 1 to 100.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1.0,
    "data": [],
    "object": "list"
  }
}
```

### Remove report tag

Remove report tag. Delete a tag from a Report

**Inputs**

- Report tag ID (`id`, text, required): Id.
- Tag (`tag`, text, required): Tag.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1.0,
    "data": [],
    "object": "list"
  }
}
```

### Replace report tags

Replace report tags. Update tags for a Report

**Inputs**

- Report tags ID (`id`, text, required): Id.
- Tags (`tags`, list, required): Tags.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "count": 1.0,
    "data": [],
    "object": "list"
  }
}
```

### Update candidate

Update candidate. Update an existing Candidate

**Inputs**

- Candidate (`id`, text, required): Id.
- First name (`first_name`, text): Candidate’s first name.
- Middle name (`middle_name`, text): Candidate’s middle name. This field is required if `no_middle_name` is `false`.
- No middle name (`no_middle_name`, true/false): Required if no `middle_name` is provided. `true` if the candidate has no middle name. Default: `false`.
- Last name (`last_name`, text): Candidate’s last name.
- Email (`email`, text): Candidate’s email address.
- Phone (`phone`, text): Candidate’s phone number.
- Zipcode (`zipcode`, text): Candidate’s 5-digit zip code.
- Dob (`dob`, date): Candidate’s date of birth.
- Custom ID (`custom_id`, text): 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 (`metadata`, object): 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**

- `data` (object): Response.

**Example output**

```json
{
  "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"
  }
}
```
