API Reference‎ > ‎People Service‎ > ‎

Resource: `sexualOffenderCheck`

A national sexual offender check on a person.

Schema

{
  "_type": "sexualOffenderCheck",
  "summary": {
    "claimedRecordCounts": {
      "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 associated person.
records Link to sexual offense records.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

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

Action: get

Fetches the sexual offender check.

Request Parameters
Parameter Type Location Required Description
embed string query no
Options: records
Response

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


Action: run

Runs a sexual offender check for the associated person.

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 sexualOffenderCheck resource will be returned in the response body.


Comments