SDKActive

Persona Embedded Flow Client SDK

JavaScript SDK for embedding Persona's identity verification flow in web apps with callbacks for UI events.

Open source page

Field note

What it does

The Persona Embedded Flow Client SDK enables web applications to embed Persona's identity verification flow. It provides callbacks like onLoad, onReady, onCancel, onComplete, onError, and onEvent for coordinating UI events. Critical business logic should rely on webhooks, not callbacks.

Capabilities

Available capabilities

Tags

Tags

Ways to use it

Ways to use it

No integrations filed yet.

Product features

Product features

eventsAllowlist

Parameter to opt in to newer events like step-transitioned, click, and form-update.

onCancel

Callback when a user cancels the flow, with inquiryId and sessionToken.

onComplete

Callback when the user completes the flow, with inquiry status and fields.

onError

Callback for errors preventing flow usability, with status and error code.

onEvent

Callback for specific flow events, with event name and metadata.

onLoad & onReady

Callbacks for when the iframe loads and when the flow is ready for interaction.