DocumentationAPI Reference
DocumentationAPI Reference

Parameters

Create a WebView and load https://withpersona.com/verify on Persona with the appropriate GET parameters. To test the WebView flow in the sandboxsandbox - A mode that allows you to test using sample data. environment, use the sandbox host domain (environment=sandbox). Your URL will probably look something like this: https://withpersona.com/verify?is-webview=true&environment=sandbox&template-id=tmpl_JAZjHuAT738Q63BdgCuEJQre.

🚧

Deprecated attributes

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

Parameter

Requirement

Description

is-webview

required

When this field is set to true, the WebView flow is activated.

template-id, inquiry-template-id, or inquiry-template-version-id

required

This 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-id

Pass a specific theme to be used.

environment

The Persona API environment on which to create inquiries. For sandboxsandbox - A mode that allows you to test using sample data. and productionproduction - A mode that allows you to run and return live data., use sandbox and production respectively.

reference-id

You 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.

fields

Provide 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.

prefill

Deprecated. Provide an object to prefill form inputs in the flow. Each attribute in the object is optional.

See Prefill documentation.

redirect-uri

The URL that loads at the end of a canceled or successful 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.