DocumentationAPI Reference
API ChangelogOpenAPI SpecStatus



WebView is not recommended

We recommend using our native mobile SDKs (Android, iOS) instead of WebView. WebView integrations experience lower conversion due to reduced performance. Support for WebView integration is only available for Enterprise customers.

For more information, see Native mobile integration vs. WebView.

Create a WebView and load on Persona with the appropriate GET parameters. Your URL will probably look something like this:


Special characters in URL parameters

Be sure to escape your values if you are passing non-alphanumeric characters in your parameters. For example, values including whitespace or symbols like + need to be escaped. In JavaScript, this can be done with encodeURIComponent.


Deprecated attributes

Deprecated attributes are planned to be removed or replaced in the future. They will continue to work in the immediate future.

is-webviewRequiredWhen this field is set to true, the WebView flow is activated.
template-id, inquiry-template-id, inquiry-template-version-id, or inquiry-idRequiredThis template ID corresponds to a pre-set configuration and determines how the flow is customized.

See Am I using Dynamic Flow Templates? for more information on the differences between Templates and Dynamic Flow Templates.
environment-idThe Persona API environment on which to create inquiries.
reference-idYou can generate and provide a unique ID which we will associate with the inquiry. The identifier can be used to monitor user progress in newly created inquiries. Inquiries with the same reference ID will be grouped under a single account.
fieldsProvide an object to set inquiry field values. Each attribute in the object is optional.

If using Dynamic Flow Templates, will also prefill form inputs in the flow.

See Fields documentation.
redirect-uriThe URL that loads at the end of a canceled or successful Inquiry flow. The default is https://personacallback.

The parameter value does not need to be a valid browser URL; arbitrary URIs such as mobile app actions or intents are accepted.
routing-countryPersona automatically routes requests to the best location, but the initial request will be slower due to the need to determine the best location.

If you know which country to route requests to directly, you can set it here to speed up the initial request.

Requests may be re-routed and incur additional latency if this value is set incorrectly. Most users do not need to set this.

For more information, see Geographical Routing.
environmentDeprecated. Use environment-id instead. The Persona API environment on which to create inquiries. For sandbox and production, use sandbox and production respectively.
prefillDeprecated. Use fields instead. Provide an object to prefill form inputs in the flow. Each attribute in the object is optional.

See Prefill documentation.
theme-idLegacy templates only. Not available for Dynamic Flow.

Pass a specific theme to be used.