Skip to content

Create eviction check

Request

Create a new eviction check.

Eviction checks search court records for eviction filings associated with the provided PII or profile. Results are returned synchronously in the response body.

Profile vs inline PII: Submit either a profile_id or inline name/identity fields (first_name, last_name, dob, ssn, etc.)—not both. Combining them returns 400 Bad Request. With profile_id, you may still send addresses (required), property_zip, and reference_id.

Providing dob is strongly encouraged — it significantly reduces false positives when multiple people share a name.

A permissible purpose must be provided to comply with FCRA requirements.

Security
get-bearer-token-using-oauth2
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 creating a new regulated eviction check.

Use either inline name/identity fields or profile_id—not both (addresses, property_zip, and reference_id may accompany profile_id). See the POST /regulated/eviction_checks operation for details.

One of:

Create an eviction check by providing PII directly. Provide either full_name, or both first_name and last_name (not both). ssn, addresses, and permissible_purpose are also required.

One of:

Provide first_name and last_name (without full_name).

object(name-parts)
POST
/regulated/eviction_checks
curl -i -X POST \
  'https://api.checkrtrust.com/v1/regulated/eviction_checks?include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "Patricia",
    "last_name": "Holloway",
    "dob": "19850314",
    "ssn": "123-45-6789",
    "permissible_purpose": "Employment",
    "addresses": [
      {
        "street": "482 Birch Lane",
        "city": "Springfield",
        "state": "IL",
        "zip_code": "62704"
      }
    ]
  }'

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:

An eviction check and its results.

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_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"
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"
resultsArray of objects(eviction_result)

Array of matched candidate records. Each item represents one person matched against the search inputs. When no eviction records are found, this will be an empty array.

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. Not intended to be parsed by computer, as these notes are not guaranteed to be in any given format.

Example:
[
  "changed last_name from 'Smith Jr' to 'Smith'"
]
profile_idstring, (uuid)(profile_id)

Identifier of an existing profile containing search criteria.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"
Response
{
  "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "profile_id": "014f2478-fc46-46d3-9f1a-b9641e1aa080",
  "created_at": "2024-03-15T10:22:04Z",
  "completed_at": "2024-03-15T10:22:05Z",
  "results": [
    { … }
  ],
  "run_notes": [
    "changed last_name from 'Holloway Jr' to 'Holloway'"
  ]
}