Delete an adhoc check
/api/v1/adhoc-checks/{adhoc_check_uuid}
operationId: adhoc-check.delete
Base: https://portal.watcheye.com.au/api/v1/adhoc-checks/{adhoc_check_uuid}
Soft-deletes the adhoc check. For a group check (check_type = group), its child checks
are deleted alongside it. See the
Soft Deletion section of the API guide
for the full policy (30-day recovery window, portal-only restore).
The records are no longer returned by list/show endpoints but remain in the database for compliance and audit purposes. The deleted adhoc check record is returned in the response as confirmation.
Path parameters
| Field | Description |
|---|---|
adhoc_check_uuidrequired |
string (uuid) The adhoc check UUID |
Responses
Adhoc check deleted (soft-delete - returned as confirmation)
application/json
| Field | Description |
|---|---|
data |
object A one-off "quick check" run from the portal by an account user against a free-form
subject, with no associated program or entity record. The base shape is the same on
the list and detail endpoints; the detail endpoint additionally embeds the typed
|
data. |
string (uuid) The adhoc check's UUID |
data. |
string A short obfuscated public identifier for the adhoc check (e.g. "Q-A1B2CD") |
data. |
string The type of check that was run. One of the supported screening operations (e.g.
|
data. |
string Display name for the check type (e.g. "PEP and Sanction Screening", "Phone Check", "Group Check"). Suitable for showing in UIs. |
data. |
string Lifecycle status of the adhoc check:
For group adhoc checks the status is rolled up from the children: any child still
pending or processing keeps the group at |
data. |
string or null Short reason why the check failed. Populated only when |
data. |
string or null High-level outcome of the check:
|
data. |
string or null Short, human-readable summary of the result (e.g. "Found 2 PEP matches", "All
phones connected", "Business record exists"). |
data. |
string or null Short, human-readable summary of the subject the check ran against (e.g. "John A
Smith, 1980-06-23" or "ACME Pty Ltd, ABN: 12 345 678 901"). For adhoc checks the
value is captured at run time from the data the user typed into the quick-check
form. |
data. |
string (date-time) or null ISO 8601 timestamp at which the check was run. |
data. |
object or null Identifies who launched the adhoc check. The
If the user has since been deleted from the account the historical record is
retained and the original |
data. |
string Discriminator for the actor type. |
data. |
string (uuid) UUID of the user or API key that launched the check. |
data. |
string Username of the portal user. Present only when |
data. |
string Label of the API key. Present only when |
data. |
string (uuid) or null UUID of the parent (group) adhoc check this check is a child of. |
api_reference |
string (uuid) |