Skip to content

Cancel county check

Request

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.

Security
get-bearer-token-using-oauth2
Path
county_check_idstring, (uuid)required

The uuid identifying the county check

Example:2b8313e8-4efd-45a1-b578-952b8313e890
Query
include[]Array of strings

Embed the profile in the response in place of profile_id.

Items ValueDescription
profile

Embeds the full profile object in place of profile_id.

Examples:
Single value
include[]=["profile"]
Bodyapplication/jsonrequired

The request body for cancelling a county check

reasonstring, [ 1 .. 500 ] charactersrequired

The reason for cancelling the county check.

Example:"Candidate withdrew application"
curl -i -X POST \
  'https://api.checkrtrust.com/v1/county_checks/2b8313e8-4efd-45a1-b578-952b8313e890/cancel?include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "Candidate withdrew application"
  }'

Responses

OK

Bodyapplication/json
idstring, (uuid)(uuid)required

A universally unique identifier (UUID) in standard format.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"
created_atstring, (date-time)(datetime)required

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(county_check_type)required

The type of county check.

Default:"county_criminal"
Value:"county_criminal"
statusstring(county_check_status)required

The current status of the county check.

  • pending — the check has been submitted and is awaiting results.
  • complete — results are available. A county_criminal.completed webhook is delivered.
  • cancelled — the search was cancelled, either at your request or because it could not be completed. When a search cannot be completed, a county_criminal.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(county_check_search_criteria)required

The search criteria used for the county check. Field presence depends on how the check was submitted:

  • PII or profile search — includes first_name, last_name, and usually date_of_birth (from the request or linked profile). case_number is omitted.
  • Case number search — includes case_number. Name and date-of-birth fields are omitted.
resultsArray of objects(record)required

The results of the 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"
]
profile_idprofile_id (string) or null
One of:

Identifier of an existing profile containing search criteria.

string (uuid)(profile_id)
profileobject(profile)

Nested profile when include[]=profile is requested. Omitted for case-number searches, which are not associated with a profile.

Response
{
  "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "created_at": "2020-01-01T00:00:00Z",
  "completed_at": "2020-01-01T00:00:00Z",
  "check_type": "county_criminal",
  "status": "pending",
  "error_reason": "cancelled",
  "reference_id": "ref-123",
  "search_criteria": {
    "first_name": "Jane",
    "middle_name": "Mary",
    "last_name": "Smith",
    "date_of_birth": "2020-01-01",
    "state": "CA",
    "county_fips_code": "06075",
    "lookback_period_in_years": 7,
    "case_number": "1992CRS000215"
  },
  "results": [
    { … }
  ],
  "run_notes": [
    "used no ruleset"
  ],
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "profile": {
    "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
    "full_name": "string",
    "first_name": "string",
    "middle_name": "string",
    "no_middle_name": false,
    "last_name": "string",
    "dob": "19950401",
    "phone": "+14155552671",
    "country_code": "string",
    "email": "john.doe@example.com",
    "ssn": "123-45-6789",
    "address": { … },
    "addresses": [ … ],
    "custom_id": "my-custom-id-123",
    "driver_license_state": "CA",
    "driver_license_number": "D1234567"
  }
}