Parameters
Query string parameters can be passed to customize the behavior of the hosted flow.
There are two main ways to use the hosted flow: creating new inquiries, and resuming existing inquiries. If you have an inquiry-id available (e.g. from creating an inquiry via API), please see Resuming existing inquiries.
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
+and&need to be escaped. In JavaScript, this can be done withencodeURIComponent.For example, if your
redirect-uriitself contains a query string,&should be replaced with%26.
Creating new inquiries
The most common way to set up the hosted flow is to specify an inquiry template ID (inquiry-template-id). This will create a new inquiry on every visit.
Optionally, you can connect new inquiries to an account. To connect the inquiry to an account, specify either referenceId or accountId. You cannot specify both.
| Parameter | Requirement | Description |
|---|---|---|
inquiry-template-idinquiry-template-version-idtemplate-id | Required | This template ID corresponds to a pre-set configuration and determines how the flow is customized. See Inquiry Templates. |
environment-id | The Persona API environment on which to create inquiries. See Environments. | |
reference-id | You can generate and provide a unique ID which we will associate with the inquiry. Oftentimes this will be the unique user identifier from your system. A new account will be created if no account with the given reference ID exists. Inquiries with the same reference ID will be associated with the same account. See Reference IDs. | |
account-id | ID of an existing account to associate newly created inquiries with. If account-id is passed, passing either reference-id or account-type-id will result in an error.See Accounts. | |
account-type-id | ID of the account type to use if creating a new account for the inquiry. If omitted, the default account type associated with the current environment will be used.account-type-id will be ignored if a new account is not created (for example, if passed with a reference-id that does not correspond with an existing account). | |
fields | Provide an object to set inquiry field values. Each attribute in the object is optional. This will also prefill form inputs corresponding to the field in the flow. See Fields. |
Resuming existing inquiries
If you have pre-created an inquiry via API or you are looking to resume an existing inquiry instead of creating a new one, use the inquiryId parameter. Do not pass a templateId or templateVersionId when resuming the inquiry.
If the inquiry already has submitted verifications, you need to specify a session-token as well. You can generate a session token with the /api/v1/inquiries//resume endpoint.
| Parameter | Required | Description |
|---|---|---|
inquiry-id | Required | Specify an inquiry ID to resume an existing inquiry. If the inquiry has a pending status, then a sessionToken from the server-side API is required. |
session-token | When resuming an inquiry with a pending status, you must also generate a session token from the server-side API.See Inquiry Sessions. |
Other parameters
These parameters are not related to creating or resuming inquiries, and can always be specified.
| Parameter | Required | Description |
|---|---|---|
language | Specify a supported language to localize the flow. Language will be inferred from browser settings by default. See Languages. | |
redirect-uri | When the user successfully verifies their identity, we redirect back to this URI. The callback should expect a GET parameter named inquiry-id that references the completed inquiry. If no redirect-uri is specified, then the success page shown to users will not have a continue button.See Redirecting On Complete. | |
routing-country | Persona 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. See Geographical Routing. | |
theme-set-id | Beta feature. Pass a specific theme set to be used. |
Deprecated parameters
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 |
|---|---|---|
environment | Deprecated. Use environment-id instead.The Persona API environment on which to create inquiries. For sandbox and production, use sandbox and production respectively. | |
prefill | Deprecated. Use fields instead.Provide an object to prefill form inputs in the flow. Each attribute in the object is optional. See Prefill documentation. | |
theme-id | Deprecated. Legacy templates only. Not available for Dynamic Flow. Pass a specific theme to be used. |
Updated 4 months ago