Create regulated check

Accounts

Endpoints and operations having to do with accounts and authorization. Account creation and credentialing will be done with a Checkr Trust team member.

Operations

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.

Operations

Criminal Checks

Criminal Checks provide criminal record check results delivered asynchronously via webhook.

Operations

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.

Operations

Driver Checks

Driver Checks provide the resulting information relevant to the requested driver license. The response will include the driver check type and results.

Operations

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.

Operations

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.

Operations

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.

Operations

Get regulated checks

Request

Get a set of regulated checks for the authenticated account.

Security

get-bearer-token-using-oauth2

Query

limitinteger[ 0 .. 999999 ]

Limit the number of records returned

Default 10

skipinteger[ 0 .. 999999 ]

Skip a number of records before returning (for paging)

Default 0

includeArray of strings

Include related resources in the response

Examples:

Include the profile in the response

Including the profile parameter will embed the full profile object in place of the profile_id

include=profile

curl -i -X GET \
  'https://api.docs.checkrtrust.com/_mock/v1/regulated/checks?limit=10&skip=0&include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [

One of:

A regulated check response with legal annotation checks included in results.

profile_idstring(uuid)(profile_id)

Identifier of an existing profile containing search criteria.

idstring(uuid)(uuid)

A universally unique identifier (UUID) in standard format.

created_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

completed_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

resultsArray of objects(record)

When there are no results found, this will be an empty array.

results[].categorystring(record_category)

A categorization of the type of record returned. Maps closely to the source category, except PA sources can contain either Patriot or Registry records.

Enum Value	Description
arrest	arrest record (includes jail/prison records)
Criminal/traffic	criminal record (includes traffic records)
Warrant	warrant record
Sex Offender	sex offender list record
Patriot	watchlist records
Registry	registry records (not necessarily implying wrongdoing, so excluded by default)

results[].personobject

results[].person.first_namestring

Example: "John"

results[].person.middle_namestring

middle initial or name or names

Example: "W"

results[].person.last_namestring

Example: "Smith"

results[].person.suffixstring

results[].person.full_namestring

Example: "Smith, John W."

results[].person.dobstring(date_string_partial)= 8 characters\d{8}

A date or partial date in the form YYYYMMDD. Since some dates are partial, they may be represented as YYYY0000 or 0000MMDD or YYYYMM00.

results[].person.inferred_dobstring(date_string_complete)= 8 characters\d{8}

Some records which do not already have a full DOB may have an inferred full DOB that was found by other means. For example a record may have no dob, or only a partial dob, but we were able to inferred a full dob using other similar records.

results[].person.doc_numberstring

Dept. of Corrections number. A number or identifier given by a state Dept. of Corrections to identify a person who went to prison.

results[].person.genderstring

The gender, if any, as recorded by the source. No specific format.

Example: "M"

results[].person.heightstring

The height, if any, as recorded by the source. No specific format.

Example: "601"

results[].person.weightstring

The weight, if any, as recorded by the source. No specific format.

Example: "180"

results[].person.hair_colorstring

The hair color, if any, as recorded by the source. No specific format.

Example: "BRN"

results[].person.eye_colorstring

The eye color if any, as recorded by the source. No specific format.

Example: "HAZ"

results[].person.skin_colorstring

The skin color, if any, as recorded by the source. No specific format.

Example: "wht"

results[].person.racestring

The race as defined by the source. No specific format.

Example: "W"

results[].person.ethnicitystring

The ethnicity, if any, as recorded by the source. No specific format.

Example: "Hispanic-American"

results[].person.physical_buildstring

The physical build, if any, as recorded by the source. No specific format.

Example: "BROAD"

results[].person.physical_marksstring

Scars, marks, and tattoos as defined by the source. No specific format.

Example: "blue cross on outside left ankle"

results[].person.photo_urlsArray of strings(uri)

A set of URLs referencing pictures of this person, as recorded by the source.

results[].person.name_aliasesArray of strings

Other names that this person may have gone by.

Example: ["Johnny Smith"]

results[].person.dob_aliasesArray of strings

Other dates of birth that this person may have used.

Example: ["19940321"]

results[].person.addressesArray of objects(address)

Addresses that are recorded for this person on this record.

results[].casesArray of objects

Only fields that have a value are returned. Most cases will have only a subset of these fields.

results[].cases[].case_numberstring

The case number assigned by a court. Not present for records which are not from a court. Format varies.

Example: "2025-99999"

results[].cases[].typestring

The case type as reported by the court. Not present for records which are not from a court. Format varies.

results[].cases[].statusstring

The case status as reported by the court. Sparsely available. Format varies.

results[].cases[].file_datestring= 8 characters\d{8}

The date the case was filed as reported by the court. Not present for records which are not from a court.

Example: "19950401"

results[].cases[].arresting_agencystring

The name of the arresting agency.

Example: "Franklin County Sheriff"

results[].cases[].arrest_datestring= 8 characters\d{8}

The date the person was arrested.

Example: "19950401"

results[].cases[].court_namestring

The name of the charging court.

Example: "Franklin County Circuit Court"

results[].cases[].court_countystring

The county of the charging court.

Example: "Franklin"

results[].cases[].chargesArray of objects

Only fields that have a value are returned. Most charges will have only a subset of these fields.

results[].cases[].checksArray of objects(legal_check)

Legal annotation check results for this case.

results[].sourceobject(source)

results[].source.idstring

An identifier for the source. E.g. "cookil" or "NJ_Supreme_Ct_view". Can be used to programmatically exclude a source.

Example: "ARSTfranklinKY"

results[].source.categorystring(source_category)

A categorization of the type of source where the data was retrieved. Some of the categories may not imply wrongdoing, and are excluded by default.

Enum Value	Description
arrest	The source contains arrest records, typically from a sheriff's department or police department.
court	The source is a municipal, county, or state court, or administrative office of courts (AOC).
criminal registry	The source is a registry of violent or drug offenders
DOC	The source is a local police jail, or state prison (DOC means Department of Correction.)
warrant	The source is one which has requested the arrest of a person, typically a police department.
sex offender registry	The source is a registry of sex offenders. Typically at the state level.
domestic watchlist	The source is a US-based list of some sort of offender.
foreign watchlist	The source is a US-based list of some sort of offender, e.g. Interpol.
healthcare registry	The source is a list of medical professionals in some capacity, and does not imply wrongdoing. (Excluded by default.)
healthcare sanctions	The source is a list of medical professionals in some capacity, and implies wrongdoing.

Example: "arrest"

results[].source.namestring

A human-understandable (English) name of the source.

Example: "KY Franklin County Inmates"

results[].source.countystring

The name of the county (if any) where the record came from.

Example: "Franklin"

results[].source.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

results[].checksArray of objects(legal_check)

Legal annotation check results for this record.

results[].checks[].action_typestring

The action type determined by the legal rule evaluation:

note: Informational annotation added to the item
investigate: The item may require further review before inclusion
remove: The item should not be reported based on legal restrictions
modified: The item was modified (e.g., certain attributes were removed)

Enum"note""investigate""remove""modified"

Example: "note"

results[].checks[].rule_idstring

Identifier of the legal rule that triggered this check result.

Example: "CA-7yr-felony"

results[].checks[].rule_typestring

The type of rule that was applied:

legal: A rule based on statutory or regulatory requirements
policy: A rule based on company policy

Enum"legal""policy"

Example: "legal"

results[].checks[].domainstring

The filter domain in which this rule was applied.

Example: "employment"

results[].checks[].descriptionstring

Human-readable description of what the legal rule evaluated.

Example: "Felony convictions older than 7 years cannot be reported in California"

results[].checks[].run_atstring(date-time)

The timestamp when this check was evaluated.

Example: "2024-01-15T10:30:00.000Z"

check_typestring(regulated_check_type)

The type of regulated check. Currently only instant_criminal_regulated is supported.

Value"instant_criminal_regulated"

reference_idstring(reference_id)^[a-zA-Z0-9_-]{1,64}$

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

run_notesArray of strings

An unstructured array of human-readable notes about this particular check. May contain notes about how input was parsed or other information about results.

]

Response

application/json

[
  {
    "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
    "created_at": "2020-01-01T00:00:00Z",
    "completed_at": "2020-01-01T00:00:00Z",
    "results": [ … ],
    "check_type": "instant_criminal_regulated",
    "reference_id": "ref-123",
    "run_notes": [ … ],
    "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
  }
]

Create regulated check

Request

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.

Security

get-bearer-token-using-oauth2

Query

includeArray of strings

Include related resources in the response

Bodyapplication/jsonrequired

The request body for creating a new regulated check with legal annotation

One of:

Request to create a regulated check using personally identifiable information (PII).

check_typestring(regulated_check_type)

The type of regulated check. Currently only instant_criminal_regulated is supported.

Value"instant_criminal_regulated"

first_namestringrequired

First name (given name). Do not include prefixes like "Ms." or "Dr."

Example: "JOHN"

middle_namestring

Middle name(s)

Example: "Mary Louise"

last_namestringrequired

Last name (surname). Do not include suffixes like "Jr." or "2nd".

Example: "SMITH"

full_namestring

Either send the full name, or first, middle (optional), and last names, but not both. If you send a full name, we will attempt to parse it into first name, middle name(s) and last name.

Example: "Smith, Jane Mary Louise"

dobstring= 8 characters\d{8}required

Date of birth in the form YYYYMMDD. Must be a valid date and cannot be in the future. If invalid, the API returns a 400 with a validation_error pointing to /dob.

Example: "19950401"

ssnstring(ssn_string)^\d{3}-?\d{2}-?\d{4}$

Social Security Number used for additional identity verification and record matching

Example: "123-45-6789"

phonestring(phone_string)^\+[1-9]\d{1,14}$

A phone number in the form +[country code][number including area code]. (E.164 format). Please note that U.S. phone numbers have a country code of "1" so all U.S. phone numbers ought to start with "+1".

Example: "+14155552671"

addressesArray of objects(address_request)

An array of addresses to search for criminal records.

Example: [{"street":"456 Oak Ave","city":"Los Angeles","state":"CA","zip_code":"90001"}]

addresses[].streetstringrequired

The street part of the address.

Unit/apartment numbers are not used for matching addresses
Street types (Avenue, Street, Boulevard) are not used for matching addresses
For example, "123 Main St., Apt. 3B" will match using "123" and "Main"

Example: "123 Main St"

addresses[].citystringrequired

The name of the city or municipality where records should be searched.

Example: "San Francisco"

addresses[].statestring(state_code)^[A-Z]{2}$required

The two-letter US state code where records should be searched.

addresses[].zip_codestring(zip_code)^\d{5}(-\d{4})?$required

US Postal Service ZIP code (5-digit or 9-digit ZIP+4 format).

addresses[].countrystring(country_code)^[A-Z]{2}$

The two-letter country code, typically "US" for United States addresses.

filter_contextobject(filter_context)required

Context information used to determine which legal rules apply when filtering check results. Jurisdictions help identify applicable state and local regulations that may affect which records can be reported.

Example: {"candidate_jurisdiction":{"state":"CA"},"decider_jurisdiction":{"state":"NY"}}

filter_context.candidate_jurisdictionobject(jurisdiction)required

The jurisdiction where the candidate (subject of the check) is located.

Example: {"state":"CA"}

filter_context.candidate_jurisdiction.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

Example: "CA"

filter_context.candidate_jurisdiction.countystring

The county name within the state.

Example: "Los Angeles"

filter_context.candidate_jurisdiction.citystring

The city name within the jurisdiction.

Example: "San Francisco"

filter_context.decider_jurisdictionobject(jurisdiction)

The jurisdiction where the decision-maker (employer/requester) is located.

Example: {"state":"NY"}

filter_context.decider_jurisdiction.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

Example: "NY"

filter_context.decider_jurisdiction.countystring

The county name within the state.

Example: "Los Angeles"

filter_context.decider_jurisdiction.citystring

The city name within the jurisdiction.

Example: "San Francisco"

filter_context.property_jurisdictionobject(jurisdiction)

The jurisdiction of the property involved (for tenancy-related checks).

filter_context.property_jurisdiction.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

filter_context.property_jurisdiction.countystring

The county name within the state.

Example: "Los Angeles"

filter_context.property_jurisdiction.citystring

The city name within the jurisdiction.

Example: "San Francisco"

permissible_purposestring(permissible_purpose)required

The permissible purpose for requesting this criminal record check, as required by the Fair Credit Reporting Act (FCRA). This must be provided for all regulated checks to ensure compliance with federal regulations.

Enum"Court Order""Consumer Instruction""Credit Transaction""Employment""Insurance Underwriting""Benefit Eligibility""Credit Risk""Consumer Initiated""Account Review""Govt Chargecard"

Example: "Employment"

ruleset_idstring(uuid)(ruleset_id)

Identifier of an existing ruleset containing filtering rules. To set up account rulesets, please reach out to your Checkr Trust Account Executive or Customer Success representative to set up the configuration.

ruleset_idsArray of strings(uuid)(ruleset_ids)

A list of ruleset identifiers to apply. When both ruleset_id and ruleset_ids are provided, they are merged and de-duplicated before applying.

Example: ["d16e88e6-aacc-4c42-9cd2-58a93dc9d8af"]

reference_idstring(reference_id)^[a-zA-Z0-9_-]{1,64}$

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

source_statesArray of strings(source_states)

An array of state abbreviations. Only records which come from a given source state are included in the results. Note that some sources are not tagged as coming from a single source state, so records from those sources will always be included. Sex offender registry records and most watchlist records are not tagged with a source state, and so will appear in the results regardless of this flag.

Example: ["CA"]

curl -i -X POST \
  'https://api.docs.checkrtrust.com/_mock/v1/regulated/checks?include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "JOHN",
    "last_name": "SMITH",
    "dob": "19900101",
    "ssn": "123-45-6789",
    "phone": "+14155552671",
    "addresses": [
      {
        "street": "456 Oak Ave",
        "city": "Los Angeles",
        "state": "CA",
        "zip_code": "90001"
      }
    ],
    "filter_context": {
      "candidate_jurisdiction": {
        "state": "CA"
      },
      "decider_jurisdiction": {
        "state": "NY"
      }
    },
    "permissible_purpose": "Employment"
  }'

Responses

Created. When the product has usage limits configured, the response includes X-RateLimit-Limit, X-RateLimit-Remaining, and optionally X-RateLimit-Expires.

Bodyapplication/json

One of:

A regulated check response with legal annotation checks included in results.

profile_idstring(uuid)(profile_id)

Identifier of an existing profile containing search criteria.

idstring(uuid)(uuid)

A universally unique identifier (UUID) in standard format.

created_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

completed_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

resultsArray of objects(record)

When there are no results found, this will be an empty array.

results[].categorystring(record_category)

A categorization of the type of record returned. Maps closely to the source category, except PA sources can contain either Patriot or Registry records.

Enum Value	Description
arrest	arrest record (includes jail/prison records)
Criminal/traffic	criminal record (includes traffic records)
Warrant	warrant record
Sex Offender	sex offender list record
Patriot	watchlist records
Registry	registry records (not necessarily implying wrongdoing, so excluded by default)

results[].personobject

results[].person.first_namestring

Example: "John"

results[].person.middle_namestring

middle initial or name or names

Example: "W"

results[].person.last_namestring

Example: "Smith"

results[].person.suffixstring

results[].person.full_namestring

Example: "Smith, John W."

results[].person.dobstring(date_string_partial)= 8 characters\d{8}

A date or partial date in the form YYYYMMDD. Since some dates are partial, they may be represented as YYYY0000 or 0000MMDD or YYYYMM00.

results[].person.inferred_dobstring(date_string_complete)= 8 characters\d{8}

Some records which do not already have a full DOB may have an inferred full DOB that was found by other means. For example a record may have no dob, or only a partial dob, but we were able to inferred a full dob using other similar records.

results[].person.doc_numberstring

Dept. of Corrections number. A number or identifier given by a state Dept. of Corrections to identify a person who went to prison.

results[].person.genderstring

The gender, if any, as recorded by the source. No specific format.

Example: "M"

results[].person.heightstring

The height, if any, as recorded by the source. No specific format.

Example: "601"

results[].person.weightstring

The weight, if any, as recorded by the source. No specific format.

Example: "180"

results[].person.hair_colorstring

The hair color, if any, as recorded by the source. No specific format.

Example: "BRN"

results[].person.eye_colorstring

The eye color if any, as recorded by the source. No specific format.

Example: "HAZ"

results[].person.skin_colorstring

The skin color, if any, as recorded by the source. No specific format.

Example: "wht"

results[].person.racestring

The race as defined by the source. No specific format.

Example: "W"

results[].person.ethnicitystring

The ethnicity, if any, as recorded by the source. No specific format.

Example: "Hispanic-American"

results[].person.physical_buildstring

The physical build, if any, as recorded by the source. No specific format.

Example: "BROAD"

results[].person.physical_marksstring

Scars, marks, and tattoos as defined by the source. No specific format.

Example: "blue cross on outside left ankle"

results[].person.photo_urlsArray of strings(uri)

A set of URLs referencing pictures of this person, as recorded by the source.

results[].person.name_aliasesArray of strings

Other names that this person may have gone by.

Example: ["Johnny Smith"]

results[].person.dob_aliasesArray of strings

Other dates of birth that this person may have used.

Example: ["19940321"]

results[].person.addressesArray of objects(address)

Addresses that are recorded for this person on this record.

results[].casesArray of objects

Only fields that have a value are returned. Most cases will have only a subset of these fields.

results[].cases[].case_numberstring

The case number assigned by a court. Not present for records which are not from a court. Format varies.

Example: "2025-99999"

results[].cases[].typestring

The case type as reported by the court. Not present for records which are not from a court. Format varies.

results[].cases[].statusstring

The case status as reported by the court. Sparsely available. Format varies.

results[].cases[].file_datestring= 8 characters\d{8}

The date the case was filed as reported by the court. Not present for records which are not from a court.

Example: "19950401"

results[].cases[].arresting_agencystring

The name of the arresting agency.

Example: "Franklin County Sheriff"

results[].cases[].arrest_datestring= 8 characters\d{8}

The date the person was arrested.

Example: "19950401"

results[].cases[].court_namestring

The name of the charging court.

Example: "Franklin County Circuit Court"

results[].cases[].court_countystring

The county of the charging court.

Example: "Franklin"

results[].cases[].chargesArray of objects

Only fields that have a value are returned. Most charges will have only a subset of these fields.

results[].cases[].checksArray of objects(legal_check)

Legal annotation check results for this case.

results[].sourceobject(source)

results[].source.idstring

An identifier for the source. E.g. "cookil" or "NJ_Supreme_Ct_view". Can be used to programmatically exclude a source.

Example: "ARSTfranklinKY"

results[].source.categorystring(source_category)

A categorization of the type of source where the data was retrieved. Some of the categories may not imply wrongdoing, and are excluded by default.

Enum Value	Description
arrest	The source contains arrest records, typically from a sheriff's department or police department.
court	The source is a municipal, county, or state court, or administrative office of courts (AOC).
criminal registry	The source is a registry of violent or drug offenders
DOC	The source is a local police jail, or state prison (DOC means Department of Correction.)
warrant	The source is one which has requested the arrest of a person, typically a police department.
sex offender registry	The source is a registry of sex offenders. Typically at the state level.
domestic watchlist	The source is a US-based list of some sort of offender.
foreign watchlist	The source is a US-based list of some sort of offender, e.g. Interpol.
healthcare registry	The source is a list of medical professionals in some capacity, and does not imply wrongdoing. (Excluded by default.)
healthcare sanctions	The source is a list of medical professionals in some capacity, and implies wrongdoing.

Example: "arrest"

results[].source.namestring

A human-understandable (English) name of the source.

Example: "KY Franklin County Inmates"

results[].source.countystring

The name of the county (if any) where the record came from.

Example: "Franklin"

results[].source.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

results[].checksArray of objects(legal_check)

Legal annotation check results for this record.

results[].checks[].action_typestring

The action type determined by the legal rule evaluation:

note: Informational annotation added to the item
investigate: The item may require further review before inclusion
remove: The item should not be reported based on legal restrictions
modified: The item was modified (e.g., certain attributes were removed)

Enum"note""investigate""remove""modified"

Example: "note"

results[].checks[].rule_idstring

Identifier of the legal rule that triggered this check result.

Example: "CA-7yr-felony"

results[].checks[].rule_typestring

The type of rule that was applied:

legal: A rule based on statutory or regulatory requirements
policy: A rule based on company policy

Enum"legal""policy"

Example: "legal"

results[].checks[].domainstring

The filter domain in which this rule was applied.

Example: "employment"

results[].checks[].descriptionstring

Human-readable description of what the legal rule evaluated.

Example: "Felony convictions older than 7 years cannot be reported in California"

results[].checks[].run_atstring(date-time)

The timestamp when this check was evaluated.

Example: "2024-01-15T10:30:00.000Z"

check_typestring(regulated_check_type)

The type of regulated check. Currently only instant_criminal_regulated is supported.

Value"instant_criminal_regulated"

reference_idstring(reference_id)^[a-zA-Z0-9_-]{1,64}$

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

run_notesArray of strings

An unstructured array of human-readable notes about this particular check. May contain notes about how input was parsed or other information about results.

Response

application/json

{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "created_at": "2020-01-01T00:00:00Z",
  "completed_at": "2020-01-01T00:00:00Z",
  "results": [
    { … }
  ],
  "check_type": "instant_criminal_regulated",
  "reference_id": "ref-123",
  "run_notes": [
    "string"
  ]
}

Get regulated check

Request

Get a single regulated check with a given id.

Security

get-bearer-token-using-oauth2

Path

check_idstring(uuid)required

The uuid identifying the check

Example: 2b8313e8-4efd-45a1-b578-952b8313e890

Query

includeArray of strings

Include related resources in the response

curl -i -X GET \
  'https://api.docs.checkrtrust.com/_mock/v1/regulated/checks/2b8313e8-4efd-45a1-b578-952b8313e890?include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

One of:

A regulated check response with legal annotation checks included in results.

profile_idstring(uuid)(profile_id)

Identifier of an existing profile containing search criteria.

idstring(uuid)(uuid)

A universally unique identifier (UUID) in standard format.

created_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

completed_atstring(date-time)(datetime)

An ISO 8601 formatted date-time string.

resultsArray of objects(record)

When there are no results found, this will be an empty array.

results[].categorystring(record_category)

A categorization of the type of record returned. Maps closely to the source category, except PA sources can contain either Patriot or Registry records.

Enum Value	Description
arrest	arrest record (includes jail/prison records)
Criminal/traffic	criminal record (includes traffic records)
Warrant	warrant record
Sex Offender	sex offender list record
Patriot	watchlist records
Registry	registry records (not necessarily implying wrongdoing, so excluded by default)

results[].personobject

results[].person.first_namestring

Example: "John"

results[].person.middle_namestring

middle initial or name or names

Example: "W"

results[].person.last_namestring

Example: "Smith"

results[].person.suffixstring

results[].person.full_namestring

Example: "Smith, John W."

results[].person.dobstring(date_string_partial)= 8 characters\d{8}

A date or partial date in the form YYYYMMDD. Since some dates are partial, they may be represented as YYYY0000 or 0000MMDD or YYYYMM00.

results[].person.inferred_dobstring(date_string_complete)= 8 characters\d{8}

Some records which do not already have a full DOB may have an inferred full DOB that was found by other means. For example a record may have no dob, or only a partial dob, but we were able to inferred a full dob using other similar records.

results[].person.doc_numberstring

Dept. of Corrections number. A number or identifier given by a state Dept. of Corrections to identify a person who went to prison.

results[].person.genderstring

The gender, if any, as recorded by the source. No specific format.

Example: "M"

results[].person.heightstring

The height, if any, as recorded by the source. No specific format.

Example: "601"

results[].person.weightstring

The weight, if any, as recorded by the source. No specific format.

Example: "180"

results[].person.hair_colorstring

The hair color, if any, as recorded by the source. No specific format.

Example: "BRN"

results[].person.eye_colorstring

The eye color if any, as recorded by the source. No specific format.

Example: "HAZ"

results[].person.skin_colorstring

The skin color, if any, as recorded by the source. No specific format.

Example: "wht"

results[].person.racestring

The race as defined by the source. No specific format.

Example: "W"

results[].person.ethnicitystring

The ethnicity, if any, as recorded by the source. No specific format.

Example: "Hispanic-American"

results[].person.physical_buildstring

The physical build, if any, as recorded by the source. No specific format.

Example: "BROAD"

results[].person.physical_marksstring

Scars, marks, and tattoos as defined by the source. No specific format.

Example: "blue cross on outside left ankle"

results[].person.photo_urlsArray of strings(uri)

A set of URLs referencing pictures of this person, as recorded by the source.

results[].person.name_aliasesArray of strings

Other names that this person may have gone by.

Example: ["Johnny Smith"]

results[].person.dob_aliasesArray of strings

Other dates of birth that this person may have used.

Example: ["19940321"]

results[].person.addressesArray of objects(address)

Addresses that are recorded for this person on this record.

results[].casesArray of objects

Only fields that have a value are returned. Most cases will have only a subset of these fields.

results[].cases[].case_numberstring

The case number assigned by a court. Not present for records which are not from a court. Format varies.

Example: "2025-99999"

results[].cases[].typestring

The case type as reported by the court. Not present for records which are not from a court. Format varies.

results[].cases[].statusstring

The case status as reported by the court. Sparsely available. Format varies.

results[].cases[].file_datestring= 8 characters\d{8}

The date the case was filed as reported by the court. Not present for records which are not from a court.

Example: "19950401"

results[].cases[].arresting_agencystring

The name of the arresting agency.

Example: "Franklin County Sheriff"

results[].cases[].arrest_datestring= 8 characters\d{8}

The date the person was arrested.

Example: "19950401"

results[].cases[].court_namestring

The name of the charging court.

Example: "Franklin County Circuit Court"

results[].cases[].court_countystring

The county of the charging court.

Example: "Franklin"

results[].cases[].chargesArray of objects

Only fields that have a value are returned. Most charges will have only a subset of these fields.

results[].cases[].checksArray of objects(legal_check)

Legal annotation check results for this case.

results[].sourceobject(source)

results[].source.idstring

An identifier for the source. E.g. "cookil" or "NJ_Supreme_Ct_view". Can be used to programmatically exclude a source.

Example: "ARSTfranklinKY"

results[].source.categorystring(source_category)

A categorization of the type of source where the data was retrieved. Some of the categories may not imply wrongdoing, and are excluded by default.

Enum Value	Description
arrest	The source contains arrest records, typically from a sheriff's department or police department.
court	The source is a municipal, county, or state court, or administrative office of courts (AOC).
criminal registry	The source is a registry of violent or drug offenders
DOC	The source is a local police jail, or state prison (DOC means Department of Correction.)
warrant	The source is one which has requested the arrest of a person, typically a police department.
sex offender registry	The source is a registry of sex offenders. Typically at the state level.
domestic watchlist	The source is a US-based list of some sort of offender.
foreign watchlist	The source is a US-based list of some sort of offender, e.g. Interpol.
healthcare registry	The source is a list of medical professionals in some capacity, and does not imply wrongdoing. (Excluded by default.)
healthcare sanctions	The source is a list of medical professionals in some capacity, and implies wrongdoing.

Example: "arrest"

results[].source.namestring

A human-understandable (English) name of the source.

Example: "KY Franklin County Inmates"

results[].source.countystring

The name of the county (if any) where the record came from.

Example: "Franklin"

results[].source.statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

results[].checksArray of objects(legal_check)

Legal annotation check results for this record.

results[].checks[].action_typestring

The action type determined by the legal rule evaluation:

note: Informational annotation added to the item
investigate: The item may require further review before inclusion
remove: The item should not be reported based on legal restrictions
modified: The item was modified (e.g., certain attributes were removed)

Enum"note""investigate""remove""modified"

Example: "note"

results[].checks[].rule_idstring

Identifier of the legal rule that triggered this check result.

Example: "CA-7yr-felony"

results[].checks[].rule_typestring

The type of rule that was applied:

legal: A rule based on statutory or regulatory requirements
policy: A rule based on company policy

Enum"legal""policy"

Example: "legal"

results[].checks[].domainstring

The filter domain in which this rule was applied.

Example: "employment"

results[].checks[].descriptionstring

Human-readable description of what the legal rule evaluated.

Example: "Felony convictions older than 7 years cannot be reported in California"

results[].checks[].run_atstring(date-time)

The timestamp when this check was evaluated.

Example: "2024-01-15T10:30:00.000Z"

check_typestring(regulated_check_type)

The type of regulated check. Currently only instant_criminal_regulated is supported.

Value"instant_criminal_regulated"

reference_idstring(reference_id)^[a-zA-Z0-9_-]{1,64}$

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

run_notesArray of strings

An unstructured array of human-readable notes about this particular check. May contain notes about how input was parsed or other information about results.

Response

application/json

{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "created_at": "2020-01-01T00:00:00Z",
  "completed_at": "2020-01-01T00:00:00Z",
  "results": [
    { … }
  ],
  "check_type": "instant_criminal_regulated",
  "reference_id": "ref-123",
  "run_notes": [
    "string"
  ]
}

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.

Operations

Checkr Trust API (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Intended Use Cases

Accounts

Instant Checks

Criminal Checks

County Checks

Driver Checks

Identity Verifications

Profiles

Regulated Checks

Get regulated checks

Request

Responses

Was this helpful?

Create regulated check

Request

Responses

Was this helpful?

Get regulated check

Request

Responses

Was this helpful?

Regulated Criminal Reports

Checkr Trust API (1.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Intended Use Cases

Accounts

Instant Checks

Criminal Checks

County Checks

Driver Checks

Identity Verifications

Profiles

Regulated Checks

Get regulated checks

Request

Responses

Was this helpful?

Create regulated check

RequestExpand all

Responses

Was this helpful?

Get regulated check

Request

Responses

Was this helpful?

Regulated Criminal Reports

Checkr Trust API (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request