Redirecting On Complete
Set the redirect-uri
query parameter of the hosted flow link to your URL for processing responses from Persona. When the hosted flow completes, it will redirect to your URL with an inquiry-id
query parameter.
Your server should optionally expect a reference-id
GET parameter if you provided one when starting the flow. For more detail on retrieving inquiries with the inquiry-id
, see /api/v1/inquiries/.
For example, if your URL is http://withpersona.com/fake-path
then you can expect the hosted flow to redirect to http://withpersona.com/fake-path?inquiry-id=inq_PDGZKPEASz266wmRcPbuwjPP&reference-id=12345
.
Query parameters
Specify the following parameters when creating the inquiry to redirect on completion.
Parameter | Optional | Description |
---|---|---|
redirect-uri | When the individual successfully verifies their identity, we redirect the user back to this URL. The callback should expect a GET parameter named inquiry-id that references the completed inquiry. | |
reference-id | Optional | 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. |
Redirect query parameters
When redirecting, Persona will specify the following query parameters.
Parameter | Nullable | |
---|---|---|
inquiry-id | ID of the completed inquiry. | |
reference-id | Nullable | If you set a reference ID on the request, it will be on the response. |
status | Status of the completed inquiry (e.g. 'completed' , 'failed' ). | |
fields | A map of field values. See Fields documentation. |
Updated over 3 years ago