For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsRelaysAPI ReferenceChangelog
OverviewInquiriesTransactionsRelaysAPI ReferenceChangelog
  • Overview
    • Inquiries Overview
    • Inquiry Model Lifecycle
    • Inquiry Templates
  • Managing inquiries
    • Creating Inquiries
    • Resuming Inquiries
    • Accessing Inquiry status and data
  • Hosted Flow integration
  • Embedded Flow integration
      • Parameters
      • Prefilling Fields
      • Client Callbacks
      • Client Methods
      • Security
      • Troubleshooting common issues
      • WebView Considerations
      • Google Tag Manager
  • Mobile SDK integration
    • Overview
    • Webview
  • Troubleshooting
    • Troubleshooting Steps
    • Troubleshooting Common Issues
LogoLogo
Help CenterOpenAPI SpecStatus
Embedded Flow integrationReference guides

Client Methods

MethodDescriptionAvailability
open()Use client.open() 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 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() (class method)Persona.Client.preload() will prepopulate the browser cache with the static JavaScript assets needed for the embedded flow, speeding up subsequent calls to client.open(). Note that this is a class method and not an instance method. Call this on Persona.Client, not on the object created from new Persona.Client().5.0.0
Was this page helpful?
Previous

Inlined

Next
Built with