List ID checks
/api/v1/id-checks
operationId: id-check.list
Base: https://portal.watcheye.com.au/api/v1/id-checks
Returns entity-bound identification checks for the calling account. Results are paginated.
Each record represents a synchronous document verification run against a saved entity
(DVS or non-DVS). The list endpoint returns a compact envelope; use
show ID check to read consent, verification details and the
typed details block.
ID checks run synchronously - there is no status field. The outcome is populated when
the check completes (pass, fail, or pending for in-flight IDPass invitations only;
IDPass is not available via this API in v1).
Filters
program_uuid- only checks for entities in the given programentity_uuid- only checks for the given entityid_type- one of the supported identification types (e.g.drivers_licence,passport)check_type- the underlying check implementation (e.g.drivers_licence_dvs)outcome-pass,fail, orpendingchecked_after/checked_before- inclusive bounds onchecked_at(ISO 8601)
The top-level archived query parameter accepts true, false, or omit for both.
Sorting
sort accepts checked_at (default -checked_at), outcome, or id_type.
Query parameters
| Field | Description |
|---|---|
page |
integer The page of results to return, starting at 1. |
per_page |
integer The number of records per page (defaults to 30, max 500). |
archived |
boolean
|
filter[program_uuid] |
string (uuid) Only records for entities in the given program. |
filter[entity_uuid] |
string (uuid) Only records for the given entity. |
filter[id_type] |
string Only ID checks of the given document type. |
filter[check_type] |
string Only records of the given check type. The endpoint description lists the values. |
filter[outcome] |
string Only records with the given outcome. The endpoint description lists the values. |
filter[checked_after] |
string (date-time) Inclusive lower bound on |
filter[checked_before] |
string (date-time) Inclusive upper bound on |
sort |
string The field to sort by, prefixed with |
Responses
Paginated ID check list
application/json
| Field | Description |
|---|---|
data |
array of objects |
data[]. |
string (uuid) |
data[]. |
string |
data[]. |
string |
data[]. |
string |
data[]. |
string |
data[]. |
string |
data[]. |
string |
data[]. |
string or null |
data[]. |
string or null |
data[]. |
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 |
data[]. |
string (date-time) or null |
data[]. |
string (date-time) or null ISO 8601 timestamp at which the identification check was archived (null if not archived) |
data[]. |
object or null |
data[]. |
string (uuid) |
data[]. |
string |
data[]. |
object or null |
data[]. |
string (uuid) |
data[]. |
string |
data[]. |
string |
data[]. |
object Present only when |
data[]. |
string (uuid) The IDPass identifier. Use it with the show, image and PDF endpoints. |
data[]. |
string Where the individual is in the hosted flow:
The last four are terminal. See the IDPass section of the guide. |
data[]. |
string or null The outcome once
|
data[]. |
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. |
data[]. |
string Path to the full IDPass resource (GET /v1/idpasses/{uuid}). |
meta |
object |
meta. |
integer |
meta. |
integer |
meta. |
integer |
meta. |
integer |
api_reference |
string (uuid) |