Parameters
Parameters can be passed to the client instance to customize the behavior of the embedded flow.
There are two main ways to use the embedded 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.
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.
For more details on the callback parameters, see Client Callbacks.
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.
The other attributes and callbacks specified above can still be used.
If the inquiry already has submitted verifications, you need to specify a sessionToken
as well. You can generate a token with the /api/v1/inquiries//resume endpoint. The token will be accessible as meta['session-token']
.
Other parameters
These parameters are not related to creating or resuming inquiries, and can always be specified.