Skip to content

Products

The individual products that make up a screening order. Each product is run as a separate report item and appears on the report keyed by its type (criminal_history, credit_report, eviction_history, identity_verification, income_verification, sex_offender_registry, global_watchlist).

Schemas

credit-report

idstring

Unique identifier for the report item.

Example:"rpi_F3hQ7wEsLp2xBnVcRuMyTk"
statusstring or null

Resolved status of this report item:

  • clear — no findings that warrant adjudication
  • consider — findings present; the result should be reviewed before making a decision

Null while the report item is still being assembled and no results have been recorded yet.

Enum:"clear""consider"null
created_atstring, (date-time)

Timestamp the report item was created.

updated_atstring, (date-time)

Timestamp the report item was last updated.

credit_file_statusstring

The status of the request for a credit file from a credit bureau. When the value is not available, a credit report cannot be generated.

ValueDescription
availableCredit file was returned and a score was generated.
frozenApplicant's credit file is frozen with the credit bureau.
not_foundEither the applicant has never used credit, or there's a mismatch in the information provided.
thin_fileA credit report could not be generated because the applicant has little or no credit history.
Enum:"available""frozen""not_found""thin_file"
Example:"available"
credit_scoreinteger or null

Applicant's credit score. null when credit_file_status is not available.

Example:712
credit_summarycredit-summary (object) or null
One of:

Aggregate metrics describing the applicant's credit profile at the time the report was produced.

{
  "id": "rpi_F3hQ7wEsLp2xBnVcRuMyTk",
  "status": "clear",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "credit_file_status": "available",
  "credit_score": 712,
  "credit_summary": {
    "total_accounts": 8,
    "on_time_payment_rate": 0.97,
    "average_account_age_months": 84,
    "credit_utilization": { … },
    "estimated_monthly_payment_cents": 142000,
    "collections_count": 0,
    "charge_offs_count": 0,
    "bankruptcies_count": 0,
    "payment_timeline": [ … ]
  }
}