Signature
Options
string
required
The
session_id from /v3/initialize. The SDK opens that run: no key, no init()."redirect" | "iframe"
default:"redirect"
redirect navigates to the hosted flow and back. iframe embeds it."drawer" | "inline"
default:"drawer"
Iframe only. Drawer overlays the page; inline mounts into
container.HTMLElement | string
Inline only. Element or CSS selector.
"fill" | "auto" | string
default:"fill"
Inline only. Or a CSS length like
640px."light" | "dark" | "auto"
default:"auto"
Iframe only.
(result: VyResult) => void
Iframe only. Same result as the promise.
() => void
Iframe only. The person dismissed without finishing.
init() instead.
iframe works only from an origin registered with us. From any other origin the browser refuses the
frame and the promise never settles. See
Register your embedding origin.Returns
Errors
Rejects when opening the session fails, with an ordinaryError today; read err.message. Never throws synchronously. Dismiss is not an error. See Errors.