# 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://trust-api-docs.redocly.app/_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://trust-api-docs.redocly.app/v1/accounts/post-accounts-token.md): Get a bearer token which will allow you to access the other endpoints in this API ## Instant Checks Instant 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://trust-api-docs.redocly.app/v1/instant-checks/get-checks.md): Get a set of checks ### Create check - [POST /checks](https://trust-api-docs.redocly.app/v1/instant-checks/post-checks.md): Create a new check ### Get check - [GET /checks/{check_id}](https://trust-api-docs.redocly.app/v1/instant-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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/v1/driver-checks/get-driver-check.md): Get a set of previously created driver checks ### Create driver check - [POST /driver_checks](https://trust-api-docs.redocly.app/v1/driver-checks/post-driver-checks.md): Create a new driver check ### Get driver check - [GET /driver_checks/{driver_check_id}](https://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/v1/identity-verifications/get-identity-verifications.md): Get a set of identity verifications ### Create identity verification - [POST /identity_verifications](https://trust-api-docs.redocly.app/v1/identity-verifications/post-identity-verifications.md): Create a new identity verification ### Get identity verification - [GET /identity_verifications/{identity_verification_id}](https://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/v1/profiles/get-profiles.md): Get a set of profiles ### Create profile - [POST /profiles](https://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/v1/profiles/get-profile-by-id.md): Get a single profile with a given id ## Regulated Checks Regulated 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://trust-api-docs.redocly.app/v1/regulated-checks/get-regulated-checks.md): Get a set of regulated checks for the authenticated account. ### Create regulated check - [POST /regulated/checks](https://trust-api-docs.redocly.app/v1/regulated-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://trust-api-docs.redocly.app/v1/regulated-checks/get-regulated-check-by-id.md): Get a single regulated 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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/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://trust-api-docs.redocly.app/v1/regulated-criminal-reports/get-regulated-criminal-report-by-id.md): Get a single regulated criminal report with a given id.