IDCanopy Developers
Hosted Verification Journeys (SDK)

Hosted UI

Load the uiHandle in an iframe or redirect the user to it

Pending verification: this page's guidance has not been re-checked against the live hosted UI.

Initialization

Use the uiHandle the handshake call returns, either inside an iframe or via a full-page redirect.

// After the handshake -> you have { uiHandle }

// Option A: iframe
document.getElementById('idcanopyFrame').src = uiHandle;

// Option B: redirect
// window.location.href = uiHandle;

Restrict where the iframe may be embedded with Content-Security-Policy: frame-ancestors or X-Frame-Options.

Events

The SDK does not emit journey events itself. If you wrap the iframe or redirect flow, you may track your own events for analytics (journey started, step completed, journey completed, etc.). Journey outcomes arrive by webhook, see Webhooks.

Reference

Specification pending, see Hosted Verification Journeys.

On this page