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.
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.
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.
Set to true to declare that the subject does not have a middle name.
Mutually exclusive with a non-empty middle_name: the API rejects requests that supply both a present middle_name and no_middle_name: true. An empty or null middle_name with no_middle_name: true is allowed. A non-empty middle_name may be supplied with no_middle_name: false.
Allowed with full_name: full_name and no_middle_name may be sent together. That is not the same as supplying middle_name — when the flag is true, parsing stores only a first name and surname, and any token the parser would have treated as a middle name is folded into the last name (for example full_name: "John Quincy Doe" becomes first name John and last name Quincy Doe, with middle_name empty).
Setting this to true clears a middle name already stored on a referenced profile. Supplying a non-empty middle_name without this field sets no_middle_name to false. When true, products that perform criminal-record identity matching exclude records with a middle name, narrowing matches to subjects with no middle name on record. When supplied with profile_id, the value is persisted to the referenced profile (same account-scoped profile the check is created against). Leave as false (or omit) if unsure.
First name (given name). Do not include prefixes like "Ms." or "Dr."
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. With no_middle_name: true, any parsed middle token is folded into the last name instead of being stored as a middle name. If you already know the first and last names, we suggest sending them.
Date of birth in YYYYMMDD format. Strongly encouraged — providing a DOB significantly reduces false positives. Must be a valid date and cannot be in the future.
Social Security Number. Required to run an eviction search.
An array of addresses associated with the person. Required — at least one address is needed to scope the eviction search.
On inline create, addresses are saved to the new profile.
[ { "street": "482 Birch Lane", "city": "Springfield", "state": "IL", "zip_code": "62704" } ]
ZIP code of the property being evaluated. When provided, eviction records are filtered to those reportable under FCRA for that property location.
The permissible purpose for requesting this eviction check, as required by the Fair Credit Reporting Act (FCRA). This must be provided for all regulated eviction checks to ensure compliance with federal regulations.
- Checkr Trust APIhttps://api.checkrtrust.com/v1/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"
}
]
}'Created. When the product has usage limits configured, the response includes X-RateLimit-Limit, X-RateLimit-Remaining, and optionally X-RateLimit-Expires.
An eviction check and its results.
A universally unique identifier (UUID) in standard format.
An ISO 8601 formatted date-time string.
An ISO 8601 formatted date-time string.
A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
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.
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.
[ "changed last_name from 'Smith Jr' to 'Smith'" ]
{ "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'" ] }