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 with encodeURIComponent
.
For example, if your redirect-uri
itself 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 every time the link is accessed.
Persona recommends connecting new inquiries to an account. To connect the inquiry to an account, specify either referenceId
or accountId
. You cannot specify both.
Access inquiry created via API or 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/[inquiry-id]/resume endpoint.
Other parameters
These parameters are not related to creating or resuming inquiries, and can always be specified.
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.