clearances

Revoke a clearance

Changed on

Sets revokedAt. The verdict stops applying at once: the next search for that subject shows the person again. The clearance stays readable with includeRevoked=true, so the audit trail is not lost.

delete/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 was revoked.

idstring

The revoked clearance's id.

revokedAtstring date-time

When it was revoked — now.

Changes