IDCanopy Developers

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.

Integration sequence

Launch the UI and receive the outcome
Launch the UI and receive the outcomeYour frontend to Your backend: Request a journey. Your backend to IDCanopy journey: Create journey server-side. IDCanopy journey to Your backend: Return uiHandle. Your backend to Your frontend: Return the launch URL. Your frontend to IDCanopy journey: Open uiHandle in iframe or redirect. IDCanopy journey to Your backend: POST journey outcome to webhook. Your backend to IDCanopy journey: Acknowledge after verifying deliveryYour frontendYour backendIDCanopy journey1. Request a journey2. Create journey server-side3. Return uiHandle4. Return the launch URL5. Open uiHandle in iframe or redirect6. POST journey outcome to webhook7. Acknowledge after verifying delivery

Integration pattern, pending live verification. User interaction takes place in the hosted UI between launch and result delivery. Browser events are not authoritative journey results. See Webhooks for the verification guidance and its current limitations.

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

See the SDK reference for integration surfaces and the current contract limitations.

On this page