clearances

Retrieve one clearance

Changed on

One clearance by id. subjectId and clientId are null on this route: only a per-account hash of them is stored, so they can be echoed only on the request that carried them.

get/v1/clearances/{clearanceId}

Request

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

Path parameters

clearanceIdstring required

The clearance id (clr_…).

Response

The clearance.

idstring

clr_ followed by an opaque id.

product'sex_offender' | 'criminal'
verdict'not_this_person' | 'this_person'
personRefstring

The person the verdict is about.

recordIdstring nullable

The result the reviewer looked at, when one was cited.

searchIdstring

The search that showed the person.

subjectIdstring nullable

Echoed from the request that carried it; null on GET /v1/clearances/{clearanceId}.

clientIdstring nullable

Echoed from the request that carried it; null when none was sent and on GET /v1/clearances/{clearanceId}.

reviewerstring nullable
notestring nullable
createdAtstring date-time
revokedAtstring date-time nullable

null while the clearance applies; set by DELETE /v1/clearances/{clearanceId}.

supersedesstring nullable

The id of the clearance this one replaced — a second verdict for the same subject, client and personRef supersedes the first. null for a first verdict.

Example response

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

Changes