# Checkr Trust API

Checkr Trust is a modern, RESTful API-driven service designed to enhance trust and safety for your platform. The Checkr Trust API uses resource-oriented URLs, supports HTTPS for authentication and requests, and returns JSON responses.

The Checkr Trust API provides access to a rich set of data, including criminal records, traffic infractions, and registry checks. Once credentialed, you can start testing locally in minutes.

## Intended Use Cases

Important: Checkr Trust is not a “consumer reporting agency” or otherwise a producer of “consumer reports,” as those terms are defined in the Fair Credit Reporting Act (“FCRA”). Checkr Trust data must not be accessed, obtained, disclosed, or otherwise used to make any decisions related to credit, insurance, employment, or any other purposes described in 15 U.S.C. § 1681b of FCRA


Version: 1.0
License: Proprietary

## Servers

Checkr Trust API
```
https://api.checkrtrust.com/v1
```

## Security

### get-bearer-token-using-oauth2

[object Object],[object Object],[object Object]

Type: oauth2
Token URL: https://api.checkrtrust.com/v1/accounts/token
Scopes:
- `read:account`: Read a single account
- `create:account`: Create an account
- `delete:account`: Delete an account
- `read:users`: List users
- `create:user`: Create / invite a user
- `read:user`: Read a single user
- `update:user`: Update a user
- `delete:user`: Delete a user
- `read:role`: Read Auth0 role metadata for a user
- `update:role`: Assign Auth0 roles to a user
- `delete:role`: Remove Auth0 roles from a user

## Download OpenAPI description

 - [Checkr Trust API](https://docs.checkrtrust.com/_bundle/v1.yaml)

## Accounts

 - [POST /accounts/token](https://docs.checkrtrust.com/v1/accounts/post-accounts-token.md): Exchange your Checkr Trust `client_id` and `client_secret` for a Bearer access token (OAuth 2.0 **client credentials**). - `grant_type` is optional; when sent it must be `client_credentials`. Any othe
## Bulk Uploads

 - [GET /bulk_uploads](https://docs.checkrtrust.com/v1/bulk-uploads/get-bulk-uploads.md): List bulk uploads for the authenticated account, newest first.
 - [POST /bulk_uploads](https://docs.checkrtrust.com/v1/bulk-uploads/post-bulk-uploads.md): Upload a CSV of subjects and start asynchronous validation for a supported check product. Supported `product_name` values: - `instant_criminal` - `instant_criminal_regulated` (requires `settings.permi
 - [GET /bulk_uploads/{bulk_upload_id}](https://docs.checkrtrust.com/v1/bulk-uploads/get-bulk-uploads-id.md): Get a single bulk upload by id.
 - [GET /bulk_uploads/{bulk_upload_id}/original](https://docs.checkrtrust.com/v1/bulk-uploads/get-bulk-uploads-id-original.md): Download the original uploaded CSV file.
 - [GET /bulk_uploads/{bulk_upload_id}/results](https://docs.checkrtrust.com/v1/bulk-uploads/get-bulk-uploads-id-results.md): Download generated results. Default `format=csv` returns the summary CSV. Pass `format=xlsx` for the detailed spreadsheet.
 - [POST /bulk_uploads/{bulk_upload_id}/force_run](https://docs.checkrtrust.com/v1/bulk-uploads/post-bulk-uploads-id-force-run.md): Enqueue processing for a bulk upload in `validated` or `invalid_input` when at least one runnable row remains. Returns `201 Created` when the job is queued (this endpoint predates the `202` convention
 - [POST /bulk_uploads/{bulk_upload_id}/regenerate_results](https://docs.checkrtrust.com/v1/bulk-uploads/post-bulk-uploads-id-regenerate-results.md): Enqueue asynchronous regeneration of the summary CSV and detailed XLSX result files for an existing bulk upload. This does not re-run checks — it only rebuilds export files from already-stored row out
## Instant Criminal Checks

 - [GET /checks](https://docs.checkrtrust.com/v1/instant-criminal-checks/get-checks.md): Get a set of checks
 - [POST /checks](https://docs.checkrtrust.com/v1/instant-criminal-checks/post-checks.md): Create a new check.
 - [GET /checks/{check_id}](https://docs.checkrtrust.com/v1/instant-criminal-checks/get-check-by-id.md): Get a single check with a given id
 - [GET /checks/{check_id}/report](https://docs.checkrtrust.com/v1/instant-criminal-checks/get-check-report-pdf.md): Download a PDF report for a single instant criminal check. The file is returned as an attachment (`Content-Disposition: attachment`) with a suggested filename of `checkr_trust_report{check_id}.pdf`. T
## Profile Criminal Checks

 - [POST /profile_criminal_checks](https://docs.checkrtrust.com/v1/profile-criminal-checks/post-profile-criminal-checks.md): Create a new profile criminal check. Unlike Instant Criminal Checks, `results` is an array of matched identities (profiles) with their own nested records, rather than a flat records array -- so a cust
 - [GET /profile_criminal_checks/{check_id}](https://docs.checkrtrust.com/v1/profile-criminal-checks/get-profile-criminal-check-by-id.md): Get a single profile criminal check with a given id.
## Criminal Checks

 - [GET /criminal_checks](https://docs.checkrtrust.com/v1/criminal-checks/get-criminal-checks.md): Get a set of criminal checks. Results are only available after webhook delivery.
 - [POST /criminal_checks](https://docs.checkrtrust.com/v1/criminal-checks/post-criminal-checks.md): Create a new criminal check. The check runs synchronously but results are only delivered via webhook. **Important Notes:** - Results are NOT returned in the HTTP response (returns 202 Accepted) - Resu
 - [GET /criminal_checks/{criminal_check_id}](https://docs.checkrtrust.com/v1/criminal-checks/get-criminal-check-by-id.md): Get a single criminal check with a given id. Results are only visible after webhook delivery.
## County Checks

 - [POST /county_checks](https://docs.checkrtrust.com/v1/county-checks/post-county-checks.md): Create a new county criminal check for a county jurisdiction, or a state-level criminal check when `county_fips_code` is the literal `statewide` (case-insensitively). This endpoint supports three mutu
 - [GET /county_checks/{county_check_id}](https://docs.checkrtrust.com/v1/county-checks/get-county-check-by-id.md): Get a single county check with a given id.
 - [POST /county_checks/{county_check_id}/cancel](https://docs.checkrtrust.com/v1/county-checks/post-county-check-cancel.md): Cancel an existing county check that is in a pending state. A reason must be provided for the cancellation. Only checks that are currently in 'pending' status can be cancelled.
## Driver Checks

 - [GET /driver_checks](https://docs.checkrtrust.com/v1/driver-checks/get-driver-checks.md): Get a set of previously created driver checks
 - [POST /driver_checks](https://docs.checkrtrust.com/v1/driver-checks/post-driver-checks.md): Create a new driver check. For `motor_vehicle_report` checks in Washington (`WA`), only DPPA purposes `employment` and `insurance` are supported. If your account is configured with a different DPPA pu
 - [GET /driver_checks/{driver_check_id}](https://docs.checkrtrust.com/v1/driver-checks/get-driver-check-by-id.md): Get a previously created driver check with a given id
## Identity Verifications

 - [GET /identity_verifications](https://docs.checkrtrust.com/v1/identity-verifications/get-identity-verifications.md): Get a set of identity verifications
 - [POST /identity_verifications](https://docs.checkrtrust.com/v1/identity-verifications/post-identity-verifications.md): Create a new identity verification.
 - [GET /identity_verifications/{identity_verification_id}](https://docs.checkrtrust.com/v1/identity-verifications/get-identity-verification-by-id.md): Get a single identity verification with a given id
 - [GET /identity_verifications/{identity_verification_id}/files](https://docs.checkrtrust.com/v1/identity-verifications/get-identity-verification-files.md): (Document Verification only) Download a ZIP of collected images for the specified identity verification. The ZIP contains the following files: - Doc_Selfie_1_blob.jpg - the selfie image - documentback
## Profiles

 - [GET /profiles](https://docs.checkrtrust.com/v1/profiles/get-profiles.md): Get a set of profiles
 - [POST /profiles](https://docs.checkrtrust.com/v1/profiles/post-profiles.md): Create a new profile with personally identifiable information (PII). The profile can include various identity fields (SSN, email, phone) which are used for identity verification and record matching i
 - [GET /profiles/{profile_id}](https://docs.checkrtrust.com/v1/profiles/get-profile-by-id.md): Get a single profile with a given id
## Regulated Adverse Action

 - [POST /regulated/pre_adverse_actions](https://docs.checkrtrust.com/v1/regulated-adverse-action/post-regulated-pre-adverse-action.md): Sends a pre-adverse action notification to the subject identified by `check_id`, giving them the opportunity to dispute the results of their background check before a final decision is made regarding
 - [GET /regulated/pre_adverse_actions/{pre_adverse_action_id}](https://docs.checkrtrust.com/v1/regulated-adverse-action/get-regulated-pre-adverse-action-by-id.md): Retrieves a single pre-adverse action record by ID.
 - [POST /regulated/adverse_actions](https://docs.checkrtrust.com/v1/regulated-adverse-action/post-regulated-adverse-action.md): Finalizes an adverse decision against the subject identified by `check_id`. Use this when your organization is declining a subject based in whole or in part on the results of a Checkr Trust background
 - [GET /regulated/adverse_actions/{adverse_action_id}](https://docs.checkrtrust.com/v1/regulated-adverse-action/get-regulated-adverse-action-by-id.md): Retrieves a single adverse action record by ID.
## Regulated Instant Criminal Checks

 - [GET /regulated/checks](https://docs.checkrtrust.com/v1/regulated-instant-criminal-checks/get-regulated-checks.md): Get a set of regulated instant criminal checks for the authenticated account.
 - [POST /regulated/checks](https://docs.checkrtrust.com/v1/regulated-instant-criminal-checks/post-regulated-checks.md): Create a new regulated criminal background check with legal annotation. This endpoint performs an instant criminal check and applies legal rules based on the provided jurisdiction context. Results inc
 - [GET /regulated/checks/{check_id}](https://docs.checkrtrust.com/v1/regulated-instant-criminal-checks/get-regulated-check-by-id.md): Get a single regulated check with a given id.
## Regulated County Checks

 - [POST /regulated/county_checks](https://docs.checkrtrust.com/v1/regulated-county-checks/post-regulated-county-checks.md): Create a new regulated county criminal check for a specific jurisdiction. This endpoint initiates a county-level or statewide criminal background check using either provided PII (personally identifiab
 - [GET /regulated/county_checks/{regulated_county_check_id}](https://docs.checkrtrust.com/v1/regulated-county-checks/get-regulated-county-check-by-id.md): Get a single regulated county check with a given id.
## Regulated Criminal Reports

 - [GET /regulated/criminal_reports](https://docs.checkrtrust.com/v1/regulated-criminal-reports/get-regulated-criminal-reports.md): Get a set of regulated criminal reports for the authenticated account.
 - [POST /regulated/criminal_reports](https://docs.checkrtrust.com/v1/regulated-criminal-reports/post-regulated-criminal-reports.md): Create a new regulated criminal report with legal annotation. This endpoint creates an asynchronous criminal report that applies legal rules based on the provided jurisdiction context. Results include
 - [GET /regulated/criminal_reports/{id}](https://docs.checkrtrust.com/v1/regulated-criminal-reports/get-regulated-criminal-report-by-id.md): Get a single regulated criminal report with a given id.
## Regulated Eviction Checks

 - [GET /regulated/eviction_checks](https://docs.checkrtrust.com/v1/regulated-eviction-checks/get-eviction-checks.md): Get a list of previously created eviction checks.
 - [POST /regulated/eviction_checks](https://docs.checkrtrust.com/v1/regulated-eviction-checks/post-eviction-checks.md): Create a new eviction check. Eviction checks search court records for eviction filings associated with the provided PII or profile. Results are returned synchronously in the response body. Providing `
 - [GET /regulated/eviction_checks/{eviction_check_id}](https://docs.checkrtrust.com/v1/regulated-eviction-checks/get-eviction-check-by-id.md): Retrieve a previously created eviction check by its ID.