API Reference‎ > ‎People Service‎ > ‎

Resource: `backgroundCheck`

A complete criminal and sexual offender background check on a person.

Schema

{
  "_type": "backgroundCheck",
  "summary": {
    "claimedOffenseCounts": {
      "unknown": {
        "likely": {number},
        "total": {number}
      },
      "other": {
        "likely": {number},
        "total": {number}
      },
      "traffic": {
        "likely": {number},
        "total": {number}
      },
      "infraction": {
        "likely": {number},
        "total": {number}
      },
      "misdemeanor": {
        "likely": {number},
        "total": {number}
      },
      "felony": {
        "likely": {number},
        "total": {number}
      },
      "sexual": {
        "likely": {number},
        "total": {number}
      },
      "all": {
        "likely": {number},
        "total": {number}
      }
    },
    "claimedRecordCounts": {
      "likely": {number},
      "total": {number}
    },
    "offenseCounts": {
      "unknown": {
        "likely": {number},
        "total": {number}
      },
      "other": {
        "likely": {number},
        "total": {number}
      },
      "traffic": {
        "likely": {number},
        "total": {number}
      },
      "infraction": {
        "likely": {number},
        "total": {number}
      },
      "misdemeanor": {
        "likely": {number},
        "total": {number}
      },
      "felony": {
        "likely": {number},
        "total": {number}
      },
      "all": {
        "likely": {number},
        "total": {number}
      }
    },
    "recordCounts": {
      "likely": {number},
      "total": {number}
    }
  },
  "status": {string},
  "creationDate": {date},
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
person Link to the person associated with the criminal check.
criminalCases Link to criminal case records for the criminal check.
sexualOffenses Link to sexual offenses for the criminal check.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes The username of the associated person.

Action: get

Fetches the criminal check.

Request Parameters
Parameter Type Location Required Description
embed string query no A comma delimited list of linked resources to embed in the response.
Options: records
Response

If successful, a criminalCheck resource will be returned in the response body.


Action: run

Runs a criminal check for the associated user.

Request Parameters
Parameter Type Location Required Description
embed string query no A comma delimited list of linked resources to embed in the response.
Options: records
Response

If successful, a criminalCheck resource will be returned in the response body.


Comments