Skip to main content

Hosted UI

Use the uiHandle returned from the Handshake (Create Journey) call to start the verification journey.
The hosted UI can be launched either inside an iframe or via full-page redirect.

Frontend Initialization

Iframe

Create an <iframe> element and set its src to the handshake uiHandle. Restrict where the iframe may be embedded (recommended): configure
Content-Security-Policy: frame-ancestors or use X-Frame-Options.

Redirect

Navigate the user directly to the hosted UI:
Optionally, your backend may issue a short-lived 302 redirect to reduce URL exposure in client logs.

Frontend Events (Optional)

If you build your own wrapper around the iframe or redirect flow, you may emit custom events such as:
  • journeyStarted
  • journeyStepCompleted
  • journeyCompleted
  • journeyFraudAlert
  • uiClosed
  • uiTimeout
These events are not emitted by the SDK; they are optional and for your own analytics/telemetry.

Example Integration