Skip to content
Finerlise
Esc
↑↓navigate↵open⌘Jpreview
On this page

Return flow reference

Technical details of sending users from your app to a form and back with a response ID.

The return flow is OAuth-shaped but simpler: no client registration and no tokens in the URL. Set it up in the form’s settings first. See Return to your website.

1. Send the user to the form

GET https://finerlise.com/f/{form}?redirect_uri={url}&state={state}
Parameter Required Rules
redirect_uri Unless only one URL is allowed Must exactly match one of the form’s Allowed return URLs (up to 5, each up to 2,048 characters). Fragments, credentials and non-local http:// URLs are rejected.
state No Up to 512 characters, with no control characters. Echoed back unchanged.

If the link is invalid, the respondent sees an error such as “This form isn’t configured to return to that website.” or “This return link is invalid.”

2. The user returns

After the response is completed, Finerlise redirects to:

{redirect_uri}?response_id={uuid}&state={state}

End pages and other redirects are skipped for that submission. Answers are never included in the URL.

3. Fetch the response

On your server, check that state matches what you sent, then read the response with a Workspace API key:

curl https://finerlise.com/api/v1/responses/{response_id} \
  -H "Authorization: Bearer $FINERLISE_API_KEY"

The body matches the data object of the response.completed webhook.

Was this page helpful?