Show an IDPass
/idpasses/{idpass_uuid}
Returns a single IDPass by UUID with its full configuration, current status, verification
outcome, document/validation summaries, activity log, available image metadata and a link
back to the originating ID check.
Example Request
GETRequest Schema
idpass_uuid
Available Response Data
13 Data Pointsuuid uuid
source enum
Whether the IDPass is bound to a saved entity or was launched adhoc: entity, adhoc
status enum
new, opened, in_progress, complete, expired, failed, …
status_name string
completed boolean
True once the IDPass has reached a terminal status
verification_status enum
passed, review, failed
verification_status_name string
requester_name string
check_liveness boolean
require_id_photo boolean
document_allowed_types object (The allowed document types for each of the (up to three) verification steps)
link_validity_days integer
api_reference uuid
unique request identifier for log tracing and audit
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Sandbox Environment
Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.
Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.
Identity verification works end to end in sandbox using the same endpoints and response shapes as live. No real SMS is sent for an IDPass delivered by SMS on a sandbox account; the message is recorded instead of delivered.
Technical Use Cases tag
Detail view in your own UI
Fetch the full IDPass record by UUID to render a detail screen inside your own application, so staff never need a second system open.
Evidence for a decision record
Retrieve the stored IDPass at the point a decision is made and attach it to your case file, with the api_reference value recorded for log tracing.
Support and reconciliation
Resolve a single UUID when investigating a discrepancy, without paging a list endpoint to find it.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
What are the rate limits?
add
What are the rate limits?
600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.
Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.
Higher limits can be arranged case by case through WatchEye support.
Ready to integrate Show an IDPass?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.