Show an adhoc ID check

GET /api/v1/adhoc-id-checks/{adhoc_id_check_uuid} operationId: adhoc-id-check.show

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

Returns a single adhoc ID check by UUID, including consent, verification details and the typed details block.

Path parameters

Field	Description
`adhoc_id_check_uuid`required	string (uuid) The uuid of the adhoc ID check.

Responses

200

Adhoc ID check response

application/json

Field Description

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

data.consent object (dynamic)

data.verification_details array of objects

data.verification_details[].field string

data.verification_details[].value string

data.details one of 6 shapes

object 1

Field	Description
`verification_result_code`	string Enum: `Y`, `N`, `D`
`originating_agency_code`	string or null
`verification_request_number`	string or null
`additional_information`	array of strings

object 2

Field	Description
`api_reference`	string or null
`message`	string or null
`match_results`	object or null
`match_results.first_name`	string
`match_results.last_name`	string
`match_results.dob`	string Date of birth match result from the upstream provider.

object 3

Field	Description
`api_reference`	string or null
`person_match`	string or null

object 4

Field	Description
`api_reference`	string or null
`reporting_reference`	string or null Unique transaction identifier from the data source.
`match_status`	string or null Overall match result. `Match` indicates the supplied identity was fully verified. Enum: `Match`, `NoMatch`
`document_verified`	boolean Whether NZTA reports the supplied licence details as verified.
`additional_information`	string or null Explanatory message returned by the data source, typically alongside a `NoMatch` result.

object 5

Field	Description
`api_reference`	string or null
`reporting_reference`	string or null Unique transaction identifier from the data source.
`match_status`	string or null Overall match result. `Match` indicates the supplied identity was fully verified. Enum: `Match`, `NoMatch`
`document_verified`	boolean Whether the NZ Department of Internal Affairs (DIA) reports the supplied passport details as verified.
`additional_information`	string or null Explanatory message returned by the data source, typically alongside a `NoMatch` result.

object 6

Field	Description
`api_reference`	string or null
`payroll_person`	string or null
`super_person`	string or null

api_reference string (uuid)

Standard error responses: 401 403 404 429 5XX See common error responses

Previous Launch an adhoc ID check Next Delete an adhoc ID check