Show an ID check

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

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

Returns a single entity-bound ID check by UUID, including consent, verification details and the typed details block. Document numbers and other sensitive input fields are never returned - see the ID check field reference for per-type input shapes.

PDF version

A verification certificate PDF is available via download ID check PDF.

Path parameters

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

Responses

200

ID check response

application/json

Field Description

data

object

An entity-bound identification check (list envelope).

data.uuid string (uuid)

data.check_number

string

Example: I-A1B2CD

data.id_type

string

Example: drivers_licence

data.id_type_name

string

Example: Drivers Licence

data.check_type

string

Example: drivers_licence_dvs

data.check_type_name

string

Example: Drivers Licence (DVS)

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.archived_at

string (date-time) or null

ISO 8601 timestamp at which the identification check was archived (null if not archived)

data.program object or null

data.program.uuid string (uuid)

data.program.program_name string

data.entity object or null

data.entity.uuid string (uuid)

data.entity.entity_number string

data.entity.entity_name string

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. Fetch that resource for the complete configuration, status, document/validation summaries and image metadata.

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 List ID checks Next Download an ID check certificate as PDF