Show an IDPass

The uuid of the IDPass.

A remote identity verification (IDPass) - list envelope.

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

Example: 5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a

Whether the IDPass is bound to a saved entity or was launched adhoc.

Enum: entity, adhoc

Example: entity

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.

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

Example: complete

True once the IDPass has reached a terminal status.

Example: true

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

Your organisation's name as shown to the individual on the consent page. It comes from the DVS identity (OAC) the IDPass was issued under.

Example: Sample Company Pty Ltd

Whether the individual was asked to complete a face liveness check.

Example: true

Whether the individual was asked to supply a standalone ID photo.

Example: true

The allowed document types for each of the (up to three) verification steps.

The document types the individual could present for the first step:

• licence - Australian driver licence
• passport - Australian passport
• medicare - Medicare card
• visa - foreign passport with an Australian visa
• centrelink - Centrelink card (details typed in, no photo)
• birth_certificate - Australian birth certificate (details typed in, no photo)
• nz_licence - New Zealand driver licence

Enum: licence, passport, medicare, visa, centrelink, birth_certificate, nz_licence

The document types for the second step, from the same list as document_1. Empty when there is no second step.

Enum: licence, passport, medicare, visa, centrelink, birth_certificate, nz_licence

The document types for the third step, from the same list as document_1. Empty when there is no third step.

Enum: licence, passport, medicare, visa, centrelink, birth_certificate, nz_licence

How many days the hosted link stays open before the IDPass expires.

Example: 7

Whether verification images are retained and made available for download.

Example: true

How the link reached the individual:

• sms - WatchEye sent it to delivery_phone by text message
• manual - you delivered idpass_link yourself

Enum: manual, sms

Example: sms

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

When the link was sent by SMS. Null when delivery_method is manual.

Example: 2026-08-01T02:15:30+00:00

When the IDPass was launched.

Example: 2026-08-01T02:15:28+00:00

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

Example: /v1/idpasses/5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a

The purpose text shown to the individual when an ID photo is required, completing the sentence "This image will be used for ...". Null when no ID photo was required.

Example: the SampleCo Membership Card

The URL the individual is offered once the verification is complete, if one was configured.

Example: https://example.com/verification-complete

The privacy policy linked from the consent page. It comes from the OAC configuration on your account.

Example: https://example.com/privacy

The DVS identity (Originating Agency Code) the IDPass was issued under.

Example: ABC123

The mobile number the link was sent to. Null when delivery_method is manual.

Example: 0412345678

A human-readable reason for verification_status, as reported by the verification platform. Null until the IDPass is terminal.

Example: The identity was verified successfully

What happened with each document the individual presented, keyed document_1, document_2 and document_3 (plus id_photo when one was required). Empty until a document has been processed. Each document carries:

• document_type - one of the allowed document types.
• ocr_status and ocr_attempts - how the photo of the document was read (running, failed or complete; null for manually entered types).
• validation_status and validation_attempts - how the document was verified.
• validation_result - the verifier's answer. For DVS-verified documents this holds verification_result_code (Y valid, N not valid, D details not found), verification_request_number, additional_information (the DVS codes and messages behind an N) and checked_at.
• biometric_result - when a liveness check was performed and the document has a photo: passed, similarity, threshold and face_occluded.
• ocr_data - the fields read from the document, and validation_data - the fields actually submitted for verification, after any corrections the individual made.

The verification outcome as a whole. Empty until the individual has finished. Contains:

• liveness_result - when a liveness check was performed: validated, confidence and liveness_attempts.
• id_photo_result - when an ID photo was required: status, image_passed and biometric_passed.
• document_1_result, document_2_result, document_3_result - per step: document_type, the validated_fields (name and date of birth) that were checked, biographic_validated, biometric_validated, biometric_similarity, biometric_threshold and any changes the individual made to the fields read from the document before verification.
• verified_identity - the name and date of birth established across the documents, or null when no consistent identity could be established.
• requested_identity_mismatch - true when the identity you supplied in data did not match the verified identity. Informational only; it does not fail the verification.

The activity log of the hosted flow, one entry per step the individual attempted. Useful for support when someone reports trouble completing the link.

When the individual accepted the consent statement. Null until they do.

Example: 2026-08-01T02:16:40+00:00

Metadata for each available image (no binary payload). Fetch the bytes via download IDPass image. Images are only present when the IDPass was launched with return_verification_images set to true.

The image identifier to pass to the image endpoint. Document images are named {document_type}_{side} (for example licence_front, licence_back, passport_photo); the liveness selfie is probe_image and the standalone ID photo is id_photo, each also available cropped to the face as probe_image_cropped and id_photo_cropped.

Example: licence_front

A display label for the image.

Example: Drivers Licence Front

Example: image/jpeg

Path to the image bytes (GET /v1/idpasses/{uuid}/images/{type}).

Example: /v1/idpasses/5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a/images/licence_front

The originating ID check (entity-bound or adhoc) plus a link to it.

Whether the ID check belongs to an entity or was adhoc.

Enum: entity, adhoc

Example: entity

Example: 8a0d2f4e-6b1c-4e9a-b3d7-2c5e1f6a9b0d

The ID check's reference number as shown in the portal.

Example: IDC-000123

Path to the ID check resource.

Example: /v1/id-checks/8a0d2f4e-6b1c-4e9a-b3d7-2c5e1f6a9b0d

Path to the verification certificate (GET /v1/idpasses/{uuid}/pdf), available once the IDPass is terminal.

Example: /v1/idpasses/5b1c7c8e-0b6e-4f0a-9b3a-1f2e3d4c5b6a/pdf