biofrq.deleteSubject

Permanently remove a subject — every face template, every attribute, every group link — from the project's gallery. The record cannot be recovered after the call returns. The audit row in SubjectDeletions is preserved.

Params

FieldTypeRequiredNotes
subjectIdUUIDyesInternal id from biofrq.enroll.

deleteSubject resolves by subjectId only — there's no externalId lookup. If your application keeps externalIdsubjectId mapping, look it up first via GET /v1/subjects?… or your own store, then call deleteSubject with the resolved subjectId.

Request

json
{
  "action": "biofrq.deleteSubject",
  "params": {
    "subjectId": "8a1c..."
  }
}

Response

The per-action payload lives at data.results[0].value:

json
{
  "deletionId":     "...",
  "subjectId":      "8a1c...",
  "tenantId":       "...",
  "groups":         ["Staff", "VIP"],
  "externalId":     "emp-4421",
  "embeddingCount": 3,
  "deletedAtUtc":   "2026-05-20T13:25:01Z"
}

The deletion row is the audit ledger entry — same shape that DELETE /v1/groups/{name} returns per deleted subject.

Common errors

  • SUBJECT_NOT_FOUNDsubjectId doesn't exist in the active project (or already deleted).
  • INVALID_REQUESTsubjectId missing or not a valid UUID.
Open in playgroundbiofrq.deleteSubject