# Create eviction check

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.
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.

Endpoint: POST /regulated/eviction_checks
Version: 1.0
Security: get-bearer-token-using-oauth2

## Security:

  - `get-bearer-token-using-oauth2` (unknown)
    oauth2

## Query parameters:

  - `include[]` (array)
    Embed the profile in the response in place of `profile_id`.

## Request body:

  - `application/json` (unknown)
    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.

## Request fields (application/json):

  - `middle_name` (string)

  - `no_middle_name` (boolean)

  - `profile_id` (string, required)
    Identifier of an existing profile containing search criteria.
    Example: 2b8313e8-4efd-45a1-b578-952b8313e890

  - `no_middle_name` (boolean)
    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.

  - `addresses` (array, required)
    **Request only.** Array of addresses supplied by the caller. Index 0 is the primary address.
When the property is provided, at least one address entry is required.
Maximum 30 addresses.
For check requests, records may be matched against any address in the array.
The singular `address` field remains supported for backwards compatibility and maps to the primary address.

  - `addresses.street` (string, required)
    Street address, including house/building number and street name.
Apartment or unit numbers may be included; they are stored but are not used for criminal-record address matching.
    Example: 123 Main St

  - `addresses.city` (string, required)
    The name of the city or municipality.
    Example: Frankfort

  - `addresses.state` (string, required)
    A two-letter US state code.
    Example: CA

  - `addresses.zip_code` (string, required)
    US Postal Service ZIP code (5-digit or 9-digit ZIP+4 format).
    Example: 94105

  - `addresses.country` (string)
    A two-letter country code in ISO 3166-1 alpha-2 format.
    Example: US

  - `property_zip` (string)
    ZIP code of the property being evaluated. When provided, eviction records are
filtered to those reportable under FCRA for that property location.
    Example: 62704

  - `permissible_purpose` (string, required)
    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.
    Enum: "Court Order", "Consumer Instruction", "Credit Transaction", "Employment", "Insurance Underwriting", "Benefit Eligibility", "Credit Risk", "Consumer Initiated", "Account Review", "Govt Chargecard", "Child Support", "Agency Liquidation"

  - `reference_id` (string)
    A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
    Example: ref-123

## Response 201:

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

## Response 201 fields (application/json):

  - `id` (string)
    A universally unique identifier (UUID) in standard format.
    Example: 2b8313e8-4efd-45a1-b578-952b8313e890

  - `created_at` (string)
    An ISO 8601 formatted date-time string.
    Example: 2020-01-01T00:00:00Z

  - `reference_id` (string)
    A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
    Example: ref-123

  - `results` (array)
    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.

  - `results.first_name` (string)
    First name of the matched candidate.
    Example: Patricia

  - `results.last_name` (string)
    Last name of the matched candidate.
    Example: Holloway

  - `results.middle_name` (string | null)
    Middle name of the matched candidate, if available.
    Example: Ann

  - `results.address` (string | null)
    Street address associated with the matched candidate.
    Example: 482 Birch Lane

  - `results.city` (string | null)
    City associated with the matched candidate.
    Example: Springfield

  - `results.state` (string | null)
    Two-letter state code associated with the matched candidate.
    Example: IL

  - `results.zip_code` (string | null)
    ZIP code associated with the matched candidate.
    Example: 62704

  - `results.zone` (string | null)
    The geographic search zone that produced this match.
Typically corresponds to a metropolitan area, county, or regional search boundary used by the data provider.
    Example: Springfield Metro

  - `results.subject` (object)
    Identity information for the subject of the eviction record, as reported by the data provider.

  - `results.subject.full_name` (string | null)
    Full name of the subject as recorded on the eviction record.
    Example: Patricia Ann Holloway

  - `results.subject.dob` (string | null)
    Date of birth of the subject in ISO 8601 format (`YYYY-MM-DD`), if available.
    Example: 1985-03-14

  - `results.subject.address` (string | null)
    Address of the subject as recorded on the eviction record.
    Example: 482 Birch Lane, Springfield, IL 62704

  - `results.subject.aliases` (string | null)
    Known aliases or alternate names for the subject, as reported by the data provider.
    Example: P. Holloway

  - `results.subject.state` (string | null)
    State associated with the subject record.
    Example: IL

  - `results.subject.jurisdiction` (string | null)
    Jurisdiction in which the eviction record originates.
    Example: Sangamon County

  - `results.subject.source` (string | null)
    Data source identifier for the record, as assigned by the data provider.
    Example: IL_SANG_EVICT

  - `results.subject.case_number` (string | null)
    Case number as recorded on the subject record.
    Example: 2023-EV-004471

  - `results.subject.category` (string | null)
    Match category assigned by the data provider (e.g. the type of match or record classification).
    Example: Eviction

  - `results.subject.status` (string | null)
    Status of the subject record as reported by the data provider.
    Example: Active

  - `results.subject.comments` (string | null)
    Free-text comments associated with the subject record, if any.
    Example: null

  - `results.case` (object)
    Court filing and judgement details for the eviction case.

  - `results.case.court` (string | null)
    Name of the court where the eviction case was filed.
    Example: Sangamon County Circuit Court

  - `results.case.case_number` (string | null)
    Case number assigned by the court.
    Example: 2023-EV-004471

  - `results.case.filing_date` (string | null)
    Date the eviction case was filed, in ISO 8601 format (`YYYY-MM-DD`).
    Example: 2023-06-12

  - `results.case.notice_type` (string | null)
    The type of eviction notice that was filed (e.g. `"Unlawful Detainer"`, `"Forcible Entry and Detainer"`, `"Pay or Quit"`).
Format varies by jurisdiction.
    Example: Forcible Entry and Detainer

  - `results.case.agency_state` (string | null)
    Two-letter state code of the agency that handled the case.
    Example: IL

  - `results.case.agency_county` (string | null)
    County of the agency that handled the case.
    Example: Sangamon

  - `results.case.dismissal_date` (string | null)
    Date the case was dismissed, in ISO 8601 format (`YYYY-MM-DD`). Null if not dismissed.
    Example: null

  - `results.case.default_judgement` (boolean)
    Whether the judgement was entered by default — i.e. the defendant did not appear or respond.
    Example: true

  - `results.case.restored_premises` (boolean)
    Whether the premises were restored (returned) to the plaintiff following the judgement.
    Example: false

  - `results.case.plaintiff` (object)
    Information about the plaintiff in the eviction case.

  - `results.case.plaintiff.name` (string | null)
    Name of the plaintiff (typically the landlord or property management company).
    Example: Riverstone Property Management LLC

  - `results.case.plaintiff.phone` (string | null)
    Phone number of the plaintiff.
    Example: 217-555-0182

  - `results.case.plaintiff.attorney` (string | null)
    Name of the plaintiff's attorney, if represented.
    Example: Gregory L. Marsh

  - `results.case.plaintiff.attorney_phone` (string | null)
    Phone number of the plaintiff's attorney.
    Example: 217-555-0199

  - `results.case.judgement` (object)
    Details of the judgement rendered in the eviction case.

  - `results.case.judgement.date` (string | null)
    Date the judgement was entered, in ISO 8601 format (`YYYY-MM-DD`).
    Example: 2023-07-05

  - `results.case.judgement.amount_cents` (integer | null)
    Monetary amount of the judgement in cents (e.g. `250000` = $2,500.00). Null if no monetary judgement.
    Example: 347500

  - `results.case.judgement.type` (string | null)
    Type of judgement as reported by the court (format varies by jurisdiction).
    Example: Judgment for Plaintiff

  - `results.case.judgement.for` (string | null)
    Party in whose favor the judgement was rendered.
    Example: Plaintiff

  - `results.case.judgement.satisfaction_amount_cents` (integer | null)
    Amount in cents by which the judgement has been satisfied. Null if not satisfied.
    Example: null

  - `results.case.judgement.release_date` (string | null)
    Date the judgement was released or satisfied, in ISO 8601 format (`YYYY-MM-DD`). Null if not yet released.
    Example: null

  - `run_notes` (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.

  - `profile_id` (string)
    Identifier of an existing profile containing search criteria.
    Example: 2b8313e8-4efd-45a1-b578-952b8313e890

  - `profile` (object)
    A profile containing personal information used for checks and verifications.

  - `profile.full_name` (string)
    The full name of the person. Must not be combined with first_name, middle_name, or last_name.
May be combined with `no_middle_name` on create/update; when that flag is `true`, parsing
stores only a first name and surname (any middle token is folded into the last name).

  - `profile.first_name` (string)
    The first name of the person.

  - `profile.middle_name` (string)
    The middle name of the person. Can be null if not provided.

  - `profile.no_middle_name` (boolean)
    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.

  - `profile.last_name` (string)
    The last name of the person.

  - `profile.dob` (string)
    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

  - `profile.phone` (string)
    A phone number in the form +[country code][number including area code].
([E.164 format](https://en.wikipedia.org/wiki/E.164)).
Please note that U.S. phone numbers have a country code of "1" so all U.S. phone numbers ought to start with "+1".
A U.S. number supplied in national format (for example "(415) 555-0123") is normalized to E.164
on write. If the value cannot be parsed as a valid phone number, the API returns a 400 with a
`validation_error`.
    Example: +14155552671

  - `profile.country_code` (string)
    The phone country calling code supplied for a reverse phone verification (for example, "1" or "54").

  - `profile.email` (string)
    An email address.
    Example: john.doe@example.com

  - `profile.ssn` (any)
    US Social Security Number.
**Masked by default** — API responses return `XXX-XX-{last4}`. Full SSN is
available via `?unmask_ssn=true` on endpoints that support it (driver checks and
identity verifications), subject to your account's product configuration. Contact
your account representative to enable SSN unmasking.
**Always `null` on list/index endpoints** (e.g. `GET /profiles`, `GET /checks`), regardless
of masking or unmasking settings. Fetch the individual resource (e.g. `GET /profiles/{id}`)
to see the masked or unmasked value for a specific record.
May also be null on a single-resource response when no SSN was provided.
    Example: XXX-XX-6789

  - `profile.address` (object)
    A US postal address supplied in a **request** (for example on check create or profile create/update).
When this object is present, `street`, `city`, `state`, and `zip_code` are required.

  - `profile.address.street` (string, required)
    Street address, including house/building number and street name.
Apartment or unit numbers may be included; they are stored but are not used for criminal-record address matching.
    Example: 123 Main St

  - `profile.address.city` (string, required)
    The name of the city or municipality.
    Example: Frankfort

  - `profile.address.state` (string, required)
    A two-letter US state code.
    Example: CA

  - `profile.address.zip_code` (string, required)
    US Postal Service ZIP code (5-digit or 9-digit ZIP+4 format).
    Example: 94105

  - `profile.address.country` (string)
    A two-letter country code in ISO 3166-1 alpha-2 format.
    Example: US

  - `profile.addresses` (array)
    **Request only.** Array of addresses supplied by the caller. Index 0 is the primary address.
When the property is provided, at least one address entry is required.
Maximum 30 addresses.
For check requests, records may be matched against any address in the array.
The singular `address` field remains supported for backwards compatibility and maps to the primary address.

  - `profile.custom_id` (string)
    An identifier of your choice, if you wish to use one. Limited to 64 alphanumeric characters, underscores, and hyphens.
    Example: my-custom-id-123

  - `profile.driver_license_number` (string)
    The driver license number. Format dependent on State.
    Example: D1234567

## Response 400:

  - `400` (unknown)
    Error response

## Response 400 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 401:

  - `401` (unknown)
    Error response

## Response 401 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 403:

  - `403` (unknown)
    Error response

## Response 403 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 429:

  - `429` (unknown)
    Too Many Requests - the product configuration has reached its usage limit or product access has expired.
When usage limits are configured, the response includes X-RateLimit-* headers (see below).

## Response 429 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 429 headers (application/json):

  - `X-RateLimit-Limit` (string)
    Maximum number of API calls allowed for this product configuration.
    Example: 100

  - `X-RateLimit-Remaining` (string)
    Number of calls remaining in the current limit period.
    Example: 0

  - `X-RateLimit-Expires` (string | null)
    ISO 8601 timestamp after which product access expires (present only when access_expires_at is set).

## Response 500:

  - `500` (unknown)
    Error response

## Response 500 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 201 examples:

  - `Response with eviction records found` (unknown)

  - `Response with no eviction records found` (unknown)