# 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 Type: oauth2 ## Download OpenAPI description [Checkr Trust API](https://docs.checkrtrust.com/_bundle/v1.yaml) ## Accounts Endpoints and operations having to do with accounts and authorization. Account creation and credentialing will be done with a Checkr Trust team member. ### Create token - [POST /accounts/token](https://docs.checkrtrust.com/v1/accounts/post-accounts-token.md): Get a bearer token which will allow you to access the other endpoints in this API ## Instant Criminal Checks Instant Criminal Checks provide the resulting information relevant to the requested check for a set of PII. Checks will include the Check type and results. ### Get checks - [GET /checks](https://docs.checkrtrust.com/v1/instant-criminal-checks/get-checks.md): Get a set of checks ### Create check - [POST /checks](https://docs.checkrtrust.com/v1/instant-criminal-checks/post-checks.md): Create a new check ### Get 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 ## Criminal Checks Criminal Checks provide criminal record check results delivered asynchronously via webhook. ### Get 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. ### Create criminal check - [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) - Results are delivered asynchronously via webhook - Webhook destination_url must be configured in product configuration ### Get criminal check - [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 County Checks provide county-level criminal background check results for a specific jurisdiction. Results are retrieved from county court records and can be cancelled while in pending status. ### Create county check - [POST /county_checks](https://docs.checkrtrust.com/v1/county-checks/post-county-checks.md): Create a new county criminal check for a specific county jurisdiction. This endpoint initiates a county-level criminal background check using either provided PII (personally identifiable information) or an existing profile. Required fields when providing PII (without profile_id): - first_name - last_name - dob - state - county_fips_code When using a profile_id, only state and county_fips_code are required. ### Get county check - [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. ### Cancel county check - [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 Driver Checks provide the resulting information relevant to the requested driver license. The response will include the driver check type and results. ### Get driver checks - [GET /driver_checks](https://docs.checkrtrust.com/v1/driver-checks/get-driver-check.md): Get a set of previously created driver checks ### Create driver check - [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 purpose, requests for motor_vehicle_report checks in WA will be rejected. This restriction does not apply to driver_license_status checks. ### Get driver check - [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 Identity Verifications provide the resulting information relevant to the requested verification for a set of PII. The response will include the IDV type and results. ### Get identity verifications - [GET /identity_verifications](https://docs.checkrtrust.com/v1/identity-verifications/get-identity-verifications.md): Get a set of identity verifications ### Create identity verification - [POST /identity_verifications](https://docs.checkrtrust.com/v1/identity-verifications/post-identity-verifications.md): Create a new identity verification ### Get 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 ### Download collected document images - [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 - documentbackDoc_Back_1_blob.jpg - the document back image - documentfrontDoc_Front_1_blob.jpg - the document front image ## Profiles Profiles represent a set of Personally Identifiable Information (PII) for a person who will be checked. Profiles can be updated with the latest information for a person and be referenced to generate checks. ### Get profiles - [GET /profiles](https://docs.checkrtrust.com/v1/profiles/get-profiles.md): Get a set of profiles ### Create profile - [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 in check products. The more identity fields provided, the better the matching and verification capabilities will be. ### Get profile - [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 Regulated Adverse Action provides two separate endpoints for the FCRA adverse action flow: Pre-Adverse Action and Adverse Action. Pre-Adverse Action notifies the subject of a pending adverse decision, delivers a copy of the report, and provides required FCRA disclosures — giving them an opportunity to dispute before a final decision is made. This step is optional but must precede a final adverse action if used. Adverse Action finalizes the adverse decision and delivers the required notice to the subject. It may be submitted with or without a prior pre-adverse action. ### Create a pre-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 profile_id, giving them the opportunity to dispute the results of their background check before a final decision is made regarding their eligibility. This ensures compliance and fairness in the decision-making process. This step is optional but must precede a final adverse action if used. Cannot be submitted after an adverse action has already been taken for this profile. ### Get a pre-adverse action - [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. ### Create an adverse action - [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 profile_id. Use this when your organization is declining a subject based in whole or in part on the results of a Checkr Trust background check. Delivers the required adverse action notice to the subject so they can seek assistance or initiate a dispute. In the event a dispute is resolved with changes to the report, Checkr Trust will notify your organization so you can reassess the subject's eligibility. May be submitted with or without a prior pre-adverse action. Including disqualifying_records is optional but strongly recommended — FCRA requires disclosing which records triggered the adverse decision. ### Get an adverse action - [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 Regulated Instant Criminal Checks provide instant criminal record check results with legal annotation. Results include checks at the record, case, and charge levels indicating compliance with applicable legal rules. A permissible purpose is required for FCRA compliance. ### Get regulated 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. ### Create regulated check - [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 include legal annotation checks at the record, case, and charge levels indicating whether items should be included, investigated, or removed based on applicable regulations. A permissible purpose must be provided to comply with FCRA requirements. ### Get regulated check - [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 Regulated County Checks provide county-level or statewide criminal background check results for a specific jurisdiction. Provide a county FIPS code for a county-level search, or omit it for a statewide search. Results include checks at the record, case, and charge levels indicating compliance with applicable legal rules. A permissible purpose is required for FCRA compliance. ### Create regulated county check - [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 identifiable information) or an existing profile. Results include legal annotation checks at the record, case, and charge levels indicating whether items should be included, investigated, or removed based on applicable regulations. A permissible purpose must be provided to comply with FCRA requirements. To perform a county-level check, provide a county_fips_code along with the state. To perform a statewide check, provide only the state and omit county_fips_code. Required fields when providing PII (without profile_id): - first_name - last_name - dob - state - filter_context - permissible_purpose When using a profile_id, state, filter_context, and permissible_purpose are required. ### Get regulated county check - [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 Regulated Criminal Reports provide asynchronous criminal record check results with legal annotation. Results are delivered via webhook once processing is complete. A permissible purpose is required for Fair Credit Reporting Act (FCRA) compliance. ### Get 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. ### Create regulated criminal report - [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 legal annotation checks at the record, case, and charge levels indicating whether items should be included, investigated, or removed based on applicable regulations. A permissible purpose must be provided to comply with Fair Credit Reporting Act (FCRA) requirements. Important Notes: - Results are NOT returned in the HTTP response (returns 202 Accepted) - Full results are delivered asynchronously via webhook once processing is complete ### Get regulated criminal report - [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 Regulated Eviction Checks surface eviction court records. Results are returned synchronously and include case filing details, plaintiff information, and judgement data. ### Get 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. ### Create eviction check - [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. You can pass PII directly (first_name, last_name, and optional middle_name, dob, addresses) or reference a stored profile via profile_id. If both are provided, the profile's PII takes precedence. Providing dob is strongly encouraged — it significantly reduces false positives when multiple people share a name. ### Get eviction check - [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.