DocumentationAPI Reference
DocumentationAPI Reference

Quickstart: Hosted Flow

Getting users to your Hosted Flow is as simple as giving them your hosted flow link, which can be found in the Development tab of your DashboardDashboard - A hub for organizations to review inquiries and manage their integration with Persona..

Directing to the flow

To start the hosted flow, link a user to /verify on Persona with the appropriate GET parameters. To test the hosted flow in your sandbox, use the sandboxsandbox - A mode that allows you to test using sample data. host domain.

An example link is https://withpersona.com/verify?template-id=tmpl_JAZjHuAT738Q63BdgCuEJQre
Swap the template ID with yours to create your hosted flow link.

Parameters

To include a parameter in your hosted flow link, add it to the end of the URL. For example, add an Environment to the above link by adding the environment parameter to the end.

Example URL for Template:
https://withpersona.com/verify?template-id=tmpl_JAZjHuAT738Q63BdgCuEJQre

Example URL for Inquiry Template Version ([email protected] or later):
https://withpersona.com/verify?inquiry-template-version-id=itmplv_Y1vuHAGRB6DAyBnFdbr82u7N

Example URL for Template with optional fields:
https://withpersona.com/verify?template-id=tmpl_JAZjHuAT738Q63BdgCuEJQre&environment=sandbox&reference-id=user_id1&language=ja&fields[name-first]=Jane

Example URL for resuming an existing inquiry:
https://withpersona.com/verify?inquiry-id=inq_PDGZKPEASz266wmRcPbuwjPP&session-token=123456&redirect-uri=https://withpersona.com/done