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.
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.government_identifiers_redacted_at
string (date-time) or null
ISO 8601 timestamp at which the government issued identifiers (licence, card, passport,
Medicare, certificate and registration numbers) were removed from this check under the
account's government identifier retention setting, or null while they are still held.
Once set, those numbers read Redacted in data_summary and in the PDF certificate.
See government_id_retention_days on the account resource.
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.