clearances

List the clearances recorded for one subject

Changed on

Every clearance recorded for subjectId (and clientId, when you send one), newest first. Active clearances only unless includeRevoked=true. The ids you send are hashed before the lookup, exactly as they were when the clearances were recorded, so a listing needs the same subjectId and clientId the verdict was recorded under.

get/v1/clearances

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/clearances
  • Auth: API key in header X-API-Key

Query parameters

subjectIdstring required

Your id for the subject, as sent when the clearances were recorded.

clientIdstring

Your facility / tenant / client id, when the clearances were recorded with one.

product'sex_offender' | 'criminal'

Restrict to one dataset. Omit for both.

includeRevokedboolean

true also returns revoked clearances. Default false: active ones only.

Response

The subject's clearances, newest first.

Example response

{
  "clearances": [
    {
      "id": "clr_7d2f41c0a9b3e8f6",
      "personRef": "prs_3c9e1f0a7b2d4e6f8a1b",
      "recordId": "rec_6d066763131ebe8c77ea",
      "searchId": "srch_9f2c1a7b",
      "subjectId": "resident-48213",
      "clientId": "facility-07"
    }
  ]
}

Changes