Get regulated county check

Request

Get a single regulated county check with a given id.

Security

get-bearer-token-using-oauth2

Path

regulated_county_check_idstring, (uuid)required

The uuid identifying the regulated county check

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

Query

include[]Array of strings

Request optional response fields. Repeat the parameter for multiple values.

Items Enum Value	Description
profile	Embeds the full profile object in place of `profile_id`.
review	Embeds the regulated check review object (accept/decline/dispute status).

Examples:

Single value

include[]=["profile"]

Multiple values

include[]=["profile","review"]

GET

/regulated/county_checks/{regulated_county_check_id}

curl -i -X GET \
  'https://api.checkrtrust.com/v1/regulated/county_checks/2b8313e8-4efd-45a1-b578-952b8313e890?include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

One of:

A regulated county criminal check response.

idstring, (uuid)(uuid)

A universally unique identifier (UUID) in standard format.

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

created_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

completed_atdatetime (string) or null

One of:

An ISO 8601 formatted date-time string.

string (date-time)(datetime)

check_typestring(regulated_county_check_type)

The type of regulated county check.

Default:"county_criminal_regulated"

Value:"county_criminal_regulated"

statusstring(regulated_county_check_status)

The current status of the regulated county check.

pending — the check has been submitted and is awaiting results.
complete — results are available.
cancelled — the search was cancelled, either at your request or because it could not be completed. When a search cannot be completed, a county_check.not_available webhook is delivered.

Enum:"pending""complete""cancelled"

Example:"pending"

error_reasonstring(check_error_reason)

A machine-readable reason for a check's error status. Only present when the check has errored.

provider_error — the third-party data provider returned an unrecoverable error.
timeout — the check did not complete within the allowed time window.
cancelled — the check was cancelled, either at your request or because it could not be completed.
need_more_info — additional identity information (e.g. email or SSN) is required to view results.

Enum:"provider_error""timeout""cancelled""need_more_info"

Example:"cancelled"

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.

Example:"ref-123"

search_criteriaobject(regulated_county_check_search_criteria)

The search criteria used for the regulated county check.

resultsArray of objects(regulated_record)

The results of the regulated county check. Empty array if no records found or if the check is still pending.

run_notesArray of strings(run_notes)

An unstructured array of human-readable notes about this particular check. May contain notes about how input was parsed or other information about results. Not intended to be parsed by computer, as these notes are not guaranteed to be in any given format.

Example:

[
  "used no ruleset"
]

reviewcheck_review (object) or null

One of:

Customer accept/decline/dispute state for a regulated check.

adverse_action_enabledboolean

Present only when include[]=review is requested; omitted otherwise. Indicates whether adverse-action workflow is enabled for this product.

profile_idstring, (uuid)(profile_id)

Identifier of an existing profile containing search criteria.

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

Response

{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
}