{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/","routeSlug":"/"},{"type":"group","fsPath":"accounts.md","metadata":{"type":"markdown"},"label":"Accounts","link":"/accounts","routeSlug":"/accounts","items":[{"type":"link","fsPath":"test-accounts.md","metadata":{"type":"markdown"},"label":"Test Accounts","link":"/test-accounts","routeSlug":"/test-accounts"}]},{"type":"link","label":"Checkr Trust API","link":"/v1","routeSlug":"/v1"},{"type":"separator","label":"Resources"},{"type":"group","label":"Accounts","link":"/v1/accounts","routeSlug":"/v1/accounts","items":[{"label":"Create token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/accounts/post-accounts-token","routeSlug":"/v1/accounts/post-accounts-token","metadata":{"seo":{"title":"Create token","description":"Exchange your Checkr Trust client_id and client_secret for a Beareraccess token (OAuth 2.0 client credentials)."}},"httpPath":"/accounts/token"}]},{"type":"group","label":"Bulk Uploads","link":"/v1/bulk-uploads","routeSlug":"/v1/bulk-uploads","items":[{"label":"List bulk uploads","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/get-bulk-uploads","routeSlug":"/v1/bulk-uploads/get-bulk-uploads","metadata":{"seo":{"title":"List bulk uploads","description":"List bulk uploads for the authenticated account, newest first."}},"httpPath":"/bulk_uploads"},{"label":"Create bulk upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/post-bulk-uploads","routeSlug":"/v1/bulk-uploads/post-bulk-uploads","metadata":{"seo":{"title":"Create bulk upload","description":"Upload a CSV of subjects and start asynchronous validation for a supportedcheck product."}},"httpPath":"/bulk_uploads"},{"label":"Get bulk upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/get-bulk-uploads-id","routeSlug":"/v1/bulk-uploads/get-bulk-uploads-id","metadata":{"seo":{"title":"Get bulk upload","description":"Get a single bulk upload by id."}},"httpPath":"/bulk_uploads/{bulk_upload_id}"},{"label":"Download original CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/get-bulk-uploads-id-original","routeSlug":"/v1/bulk-uploads/get-bulk-uploads-id-original","metadata":{"seo":{"title":"Download original CSV","description":"Download the original uploaded CSV file."}},"httpPath":"/bulk_uploads/{bulk_upload_id}/original"},{"label":"Download result file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/get-bulk-uploads-id-results","routeSlug":"/v1/bulk-uploads/get-bulk-uploads-id-results","metadata":{"seo":{"title":"Download result file","description":"Download generated results. Default format=csv returns the summary CSV.Pass format=xlsx for the detailed spreadsheet."}},"httpPath":"/bulk_uploads/{bulk_upload_id}/results"},{"label":"Force-run a validated bulk upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/post-bulk-uploads-id-force-run","routeSlug":"/v1/bulk-uploads/post-bulk-uploads-id-force-run","metadata":{"seo":{"title":"Force-run a validated bulk upload","description":"Enqueue processing for a bulk upload in validated or invalid_inputwhen at least one runnable row remains. Returns 201 Created when thejob is queued (this endpoint predates the 202 convention used byregenerate_results). Poll GET /v1/bulk_uploads/{bulk_upload_id} forstate transitions — do not poll this POST endpoint."}},"httpPath":"/bulk_uploads/{bulk_upload_id}/force_run"},{"label":"Regenerate result files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/bulk-uploads/post-bulk-uploads-id-regenerate-results","routeSlug":"/v1/bulk-uploads/post-bulk-uploads-id-regenerate-results","metadata":{"seo":{"title":"Regenerate result files","description":"Enqueue asynchronous regeneration of the summary CSV and detailed XLSX resultfiles for an existing bulk upload. This does not re-run checks — it only rebuildsexport files from already-stored row outcomes."}},"httpPath":"/bulk_uploads/{bulk_upload_id}/regenerate_results"}]},{"type":"group","label":"Instant Criminal Checks","link":"/v1/instant-criminal-checks","routeSlug":"/v1/instant-criminal-checks","items":[{"label":"Get checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/instant-criminal-checks/get-checks","routeSlug":"/v1/instant-criminal-checks/get-checks","metadata":{"seo":{"title":"Get checks","description":"Get a set of checks"}},"httpPath":"/checks"},{"label":"Create check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/instant-criminal-checks/post-checks","routeSlug":"/v1/instant-criminal-checks/post-checks","metadata":{"seo":{"title":"Create check","description":"Create a new check."}},"httpPath":"/checks"},{"label":"Get check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/instant-criminal-checks/get-check-by-id","routeSlug":"/v1/instant-criminal-checks/get-check-by-id","metadata":{"seo":{"title":"Get check","description":"Get a single check with a given id"}},"httpPath":"/checks/{check_id}"},{"label":"Download check report (PDF)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/instant-criminal-checks/get-check-report-pdf","routeSlug":"/v1/instant-criminal-checks/get-check-report-pdf","metadata":{"seo":{"title":"Download check report (PDF)","description":"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."}},"httpPath":"/checks/{check_id}/report"}]},{"type":"group","label":"Profile Criminal Checks","link":"/v1/profile-criminal-checks","routeSlug":"/v1/profile-criminal-checks","items":[{"label":"Create profile criminal check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/profile-criminal-checks/post-profile-criminal-checks","routeSlug":"/v1/profile-criminal-checks/post-profile-criminal-checks","metadata":{"seo":{"title":"Create profile criminal check","description":"Create a new profile criminal check. Unlike Instant Criminal Checks, results is an arrayof matched identities (profiles) with their own nested records, rather than a flat recordsarray -- so a customer can first review which identity matched before drilling into itsrecords."}},"badges":[{"name":"Beta","color":"purple","position":"before"}],"httpPath":"/profile_criminal_checks"},{"label":"Get profile criminal check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/profile-criminal-checks/get-profile-criminal-check-by-id","routeSlug":"/v1/profile-criminal-checks/get-profile-criminal-check-by-id","metadata":{"seo":{"title":"Get profile criminal check","description":"Get a single profile criminal check with a given id."}},"badges":[{"name":"Beta","color":"purple","position":"before"}],"httpPath":"/profile_criminal_checks/{check_id}"}]},{"type":"group","label":"Criminal Checks","link":"/v1/criminal-checks","routeSlug":"/v1/criminal-checks","items":[{"label":"Get criminal checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/criminal-checks/get-criminal-checks","routeSlug":"/v1/criminal-checks/get-criminal-checks","metadata":{"seo":{"title":"Get criminal checks","description":"Get a set of criminal checks. Results are only available after webhook delivery."}},"httpPath":"/criminal_checks"},{"label":"Create criminal check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/criminal-checks/post-criminal-checks","routeSlug":"/v1/criminal-checks/post-criminal-checks","metadata":{"seo":{"title":"Create criminal check","description":"Create a new criminal check. The check runs synchronously but results are only delivered via webhook."}},"httpPath":"/criminal_checks"},{"label":"Get criminal check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/criminal-checks/get-criminal-check-by-id","routeSlug":"/v1/criminal-checks/get-criminal-check-by-id","metadata":{"seo":{"title":"Get criminal check","description":"Get a single criminal check with a given id. Results are only visible after webhook delivery."}},"httpPath":"/criminal_checks/{criminal_check_id}"}]},{"type":"group","label":"County Checks","link":"/v1/county-checks","routeSlug":"/v1/county-checks","items":[{"label":"Create county check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/county-checks/post-county-checks","routeSlug":"/v1/county-checks/post-county-checks","metadata":{"seo":{"title":"Create county check","description":"Create a new county criminal check for a county jurisdiction, or a state-level criminal check whencounty_fips_code is the literal statewide (case-insensitively)."}},"httpPath":"/county_checks"},{"label":"Get county check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/county-checks/get-county-check-by-id","routeSlug":"/v1/county-checks/get-county-check-by-id","metadata":{"seo":{"title":"Get county check","description":"Get a single county check with a given id."}},"httpPath":"/county_checks/{county_check_id}"},{"label":"Cancel county check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/county-checks/post-county-check-cancel","routeSlug":"/v1/county-checks/post-county-check-cancel","metadata":{"seo":{"title":"Cancel county check","description":"Cancel an existing county check that is in a pending state."}},"httpPath":"/county_checks/{county_check_id}/cancel"}]},{"type":"group","label":"Driver Checks","link":"/v1/driver-checks","routeSlug":"/v1/driver-checks","items":[{"label":"Get driver checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/driver-checks/get-driver-checks","routeSlug":"/v1/driver-checks/get-driver-checks","metadata":{"seo":{"title":"Get driver checks","description":"Get a set of previously created driver checks"}},"httpPath":"/driver_checks"},{"label":"Create driver check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/driver-checks/post-driver-checks","routeSlug":"/v1/driver-checks/post-driver-checks","metadata":{"seo":{"title":"Create driver check","description":"Create a new driver check."}},"httpPath":"/driver_checks"},{"label":"Get driver check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/driver-checks/get-driver-check-by-id","routeSlug":"/v1/driver-checks/get-driver-check-by-id","metadata":{"seo":{"title":"Get driver check","description":"Get a previously created driver check with a given id"}},"httpPath":"/driver_checks/{driver_check_id}"}]},{"type":"group","label":"Identity Verifications","link":"/v1/identity-verifications","routeSlug":"/v1/identity-verifications","items":[{"label":"Get identity verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/identity-verifications/get-identity-verifications","routeSlug":"/v1/identity-verifications/get-identity-verifications","metadata":{"seo":{"title":"Get identity verifications","description":"Get a set of identity verifications"}},"httpPath":"/identity_verifications"},{"label":"Create identity verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/identity-verifications/post-identity-verifications","routeSlug":"/v1/identity-verifications/post-identity-verifications","metadata":{"seo":{"title":"Create identity verification","description":"Create a new identity verification."}},"httpPath":"/identity_verifications"},{"label":"Get identity verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/identity-verifications/get-identity-verification-by-id","routeSlug":"/v1/identity-verifications/get-identity-verification-by-id","metadata":{"seo":{"title":"Get identity verification","description":"Get a single identity verification with a given id"}},"httpPath":"/identity_verifications/{identity_verification_id}"},{"label":"Download collected document images","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/identity-verifications/get-identity-verification-files","routeSlug":"/v1/identity-verifications/get-identity-verification-files","metadata":{"seo":{"title":"Download collected document images","description":"(Document Verification only) Download a ZIP of collected images for the specified identity verification.The ZIP contains the following files:"}},"httpPath":"/identity_verifications/{identity_verification_id}/files"}]},{"type":"group","label":"Profiles","link":"/v1/profiles","routeSlug":"/v1/profiles","items":[{"label":"Get profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/profiles/get-profiles","routeSlug":"/v1/profiles/get-profiles","metadata":{"seo":{"title":"Get profiles","description":"Get a set of profiles"}},"httpPath":"/profiles"},{"label":"Create profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/profiles/post-profiles","routeSlug":"/v1/profiles/post-profiles","metadata":{"seo":{"title":"Create profile","description":"Create a new profile with personally identifiable information (PII)."}},"httpPath":"/profiles"},{"label":"Get profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/profiles/get-profile-by-id","routeSlug":"/v1/profiles/get-profile-by-id","metadata":{"seo":{"title":"Get profile","description":"Get a single profile with a given id"}},"httpPath":"/profiles/{profile_id}"}]},{"type":"group","label":"Regulated Adverse Action","link":"/v1/regulated-adverse-action","routeSlug":"/v1/regulated-adverse-action","items":[{"label":"Create a pre-adverse action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-adverse-action/post-regulated-pre-adverse-action","routeSlug":"/v1/regulated-adverse-action/post-regulated-pre-adverse-action","metadata":{"seo":{"title":"Create a pre-adverse action","description":"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 beforea final decision is made regarding their eligibility. This ensures compliance andfairness in the decision-making process."}},"httpPath":"/regulated/pre_adverse_actions"},{"label":"Get a pre-adverse action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-adverse-action/get-regulated-pre-adverse-action-by-id","routeSlug":"/v1/regulated-adverse-action/get-regulated-pre-adverse-action-by-id","metadata":{"seo":{"title":"Get a pre-adverse action","description":"Retrieves a single pre-adverse action record by ID."}},"httpPath":"/regulated/pre_adverse_actions/{pre_adverse_action_id}"},{"label":"Create an adverse action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-adverse-action/post-regulated-adverse-action","routeSlug":"/v1/regulated-adverse-action/post-regulated-adverse-action","metadata":{"seo":{"title":"Create an adverse action","description":"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 parton the results of a Checkr Trust background check."}},"httpPath":"/regulated/adverse_actions"},{"label":"Get an adverse action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-adverse-action/get-regulated-adverse-action-by-id","routeSlug":"/v1/regulated-adverse-action/get-regulated-adverse-action-by-id","metadata":{"seo":{"title":"Get an adverse action","description":"Retrieves a single adverse action record by ID."}},"httpPath":"/regulated/adverse_actions/{adverse_action_id}"}]},{"type":"group","label":"Regulated Instant Criminal Checks","link":"/v1/regulated-instant-criminal-checks","routeSlug":"/v1/regulated-instant-criminal-checks","items":[{"label":"Get regulated checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-instant-criminal-checks/get-regulated-checks","routeSlug":"/v1/regulated-instant-criminal-checks/get-regulated-checks","metadata":{"seo":{"title":"Get regulated checks","description":"Get a set of regulated instant criminal checks for the authenticated account."}},"httpPath":"/regulated/checks"},{"label":"Create regulated check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-instant-criminal-checks/post-regulated-checks","routeSlug":"/v1/regulated-instant-criminal-checks/post-regulated-checks","metadata":{"seo":{"title":"Create regulated check","description":"Create a new regulated criminal background check with legal annotation."}},"httpPath":"/regulated/checks"},{"label":"Get regulated check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-instant-criminal-checks/get-regulated-check-by-id","routeSlug":"/v1/regulated-instant-criminal-checks/get-regulated-check-by-id","metadata":{"seo":{"title":"Get regulated check","description":"Get a single regulated check with a given id."}},"httpPath":"/regulated/checks/{check_id}"}]},{"type":"group","label":"Regulated County Checks","link":"/v1/regulated-county-checks","routeSlug":"/v1/regulated-county-checks","items":[{"label":"Create regulated county check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-county-checks/post-regulated-county-checks","routeSlug":"/v1/regulated-county-checks/post-regulated-county-checks","metadata":{"seo":{"title":"Create regulated county check","description":"Create a new regulated county criminal check for a specific jurisdiction."}},"httpPath":"/regulated/county_checks"},{"label":"Get regulated county check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-county-checks/get-regulated-county-check-by-id","routeSlug":"/v1/regulated-county-checks/get-regulated-county-check-by-id","metadata":{"seo":{"title":"Get regulated county check","description":"Get a single regulated county check with a given id."}},"httpPath":"/regulated/county_checks/{regulated_county_check_id}"}]},{"type":"group","label":"Regulated Criminal Reports","link":"/v1/regulated-criminal-reports","routeSlug":"/v1/regulated-criminal-reports","items":[{"label":"Get regulated criminal reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-criminal-reports/get-regulated-criminal-reports","routeSlug":"/v1/regulated-criminal-reports/get-regulated-criminal-reports","metadata":{"seo":{"title":"Get regulated criminal reports","description":"Get a set of regulated criminal reports for the authenticated account."}},"httpPath":"/regulated/criminal_reports"},{"label":"Create regulated criminal report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-criminal-reports/post-regulated-criminal-reports","routeSlug":"/v1/regulated-criminal-reports/post-regulated-criminal-reports","metadata":{"seo":{"title":"Create regulated criminal report","description":"Create a new regulated criminal report with legal annotation."}},"httpPath":"/regulated/criminal_reports"},{"label":"Get regulated criminal report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-criminal-reports/get-regulated-criminal-report-by-id","routeSlug":"/v1/regulated-criminal-reports/get-regulated-criminal-report-by-id","metadata":{"seo":{"title":"Get regulated criminal report","description":"Get a single regulated criminal report with a given id."}},"httpPath":"/regulated/criminal_reports/{id}"}]},{"type":"group","label":"Regulated Eviction Checks","link":"/v1/regulated-eviction-checks","routeSlug":"/v1/regulated-eviction-checks","items":[{"label":"Get eviction checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-eviction-checks/get-eviction-checks","routeSlug":"/v1/regulated-eviction-checks/get-eviction-checks","metadata":{"seo":{"title":"Get eviction checks","description":"Get a list of previously created eviction checks."}},"httpPath":"/regulated/eviction_checks"},{"label":"Create eviction check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-eviction-checks/post-eviction-checks","routeSlug":"/v1/regulated-eviction-checks/post-eviction-checks","metadata":{"seo":{"title":"Create eviction check","description":"Create a new eviction check."}},"httpPath":"/regulated/eviction_checks"},{"label":"Get eviction check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/regulated-eviction-checks/get-eviction-check-by-id","routeSlug":"/v1/regulated-eviction-checks/get-eviction-check-by-id","metadata":{"seo":{"title":"Get eviction check","description":"Retrieve a previously created eviction check by its ID."}},"httpPath":"/regulated/eviction_checks/{eviction_check_id}"}]}]}