WatchEye
Browse endpoints
View as Markdown OpenAPI spec

Delete an adhoc ID check

DELETE /api/v1/adhoc-id-checks/{adhoc_id_check_uuid} operationId: adhoc-id-check.delete

Base: https://portal.watcheye.com.au/api/v1/adhoc-id-checks/{adhoc_id_check_uuid}

Soft-deletes the adhoc ID check. See the Soft Deletion section of the API guide for the full policy (30-day recovery window, portal-only restore).

The record is no longer returned by list/show endpoints but remains in the database for compliance and audit purposes. The deleted adhoc ID check record is returned in the response as confirmation.

Path parameters

FieldDescription
adhoc_id_check_uuidrequired string (uuid)

The adhoc ID check UUID

Responses

200

Adhoc ID check deleted (soft-delete - returned as confirmation)

application/json
FieldDescription
data object

A quick (adhoc) identification check not tied to an entity.
data.uuid string (uuid)
data.check_number string
data.id_type string
data.id_type_name string
data.check_type string
data.check_type_name string
data.outcome string

Enum: pass, fail, pending
data.outcome_summary string or null
data.data_summary string or null
data.checked_at string (date-time) or null
data.created_by object or null

Identifies who launched the adhoc ID check. The type discriminator picks the shape of the remaining fields:

  • { type: "user", uuid, username } - a portal user launched the check.
  • { type: "api_key", uuid, label } - an API key on this account launched the check.
  • null - rare legacy rows from before actor attribution was recorded.
data.created_by.type string

Discriminator for the actor type.

Enum: user, api_key
data.created_by.uuid string (uuid)

UUID of the user or API key that launched the check.
data.created_by.username string

Username of the portal user. Present only when type is user.
data.created_by.label string

Label of the API key. Present only when type is api_key.
data.idpass object

Present only when id_type is idpass. A lightweight shell of the linked IDPass plus idpass_url, the path to the full IDPass resource.
data.idpass.uuid string (uuid)

The IDPass identifier. Use it with the show, image and PDF endpoints.

Example: 5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a
data.idpass.status string

Where the individual is in the hosted flow:

  • new - the link has not been opened
  • opened - the welcome page was passed
  • in_progress - consent was given and documents are being submitted
  • complete - the verification finished; read verification_status for the outcome
  • expired - link_validity_days elapsed before completion
  • failed - the verification could not be completed
  • cancelled - cancelled in the portal

The last four are terminal. See the IDPass section of the guide.

Enum: new, opened, in_progress, complete, expired, failed, cancelled

Example: in_progress
data.idpass.verification_status string or null

The outcome once status is terminal, null until then:

  • passed - the identity was verified
  • review - the identity was verified but flagged for review in the portal; treat it as not yet passed
  • failed - the identity was not verified (including an expired or cancelled IDPass)

Enum: passed, review, failed

Example: passed
data.idpass.idpass_link string or null

The hosted link the individual opens to complete their verification. Treat it as opaque - pass it on as-is and do not parse or rebuild it.

Example: https://idpass.globaldata.net.au/idpass?token=abcd123456
data.idpass.idpass_url string

Path to the full IDPass resource (GET /v1/idpasses/{uuid}).

Example: /v1/idpasses/5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a
api_reference string (uuid)
Standard error responses: 400 401 403 404 429 5XX See common error responses
Previous Show an adhoc ID check Next Download an adhoc ID check certificate as PDF