DocumentationAPI Reference
API ChangelogOpenAPI SpecStatus

Client Methods

open()Use to show the embedded flow.
cancel(force: boolean)Use client.cancel(false) to transition to the cancel confirmation screen. Use client.cancel(true) to instantly hide the the embedded flow without displaying the cancel confirmation screen.
destroy()Use client.destroy() to clean up all Persona DOM elements from the page once you are finished using the flow.

If your integration creates more than one instance of the Persona client, this method should be called when finished using each client to avoid memory leaks.
preload()client.preload() will prepopulate the browser cache with the static JavaScript assets needed for the embedded flow, speeding up subsequent calls to