DocumentationAPI Reference
DocumentationAPI ReferenceStatus

Parameters

Create a WebView and load https://inquiry.withpersona.com/verify on Persona with the appropriate GET parameters. Your URL will probably look something like this: https://inquiry.withpersona.com/verify?is-webview=true&environment-id=env_123&template-id=tmpl_123.

🚧

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.

ParameterRequirementDescription
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.
theme-idPass a specific theme to be used.
environment-idThe Persona API environment on which to create inquiries.
environmentDeprecated. Use environment-id instead. The Persona API environment on which to create inquiries. For sandbox and production, use sandbox and production respectively.
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.
prefillDeprecated. Provide an object to prefill form inputs in the flow. Each attribute in the object is optional.

See Prefill 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.