Using a Flow

End users complete Flows in a hosted web experience accessed through a unique link. Generate this link using the /initiate endpoint, then send it to the user automatically from your system (for example, via email or SMS).

Endpoint

/api/fraud-flows/initiate/{{api_key}}/{{flow_request_id}}

Request parameters

Field	Description	Required	Options	Default
api_key	The API key associated with the Flow you intend to initiate. This is likely your primary API key.	Yes
flow_request_id	The ID of the Flow you intend to initiate.	Yes
run_type	How to initiate the Flow. If set to link it will simply return the Flow link. If set to email the email field must also be set and an email will be sent. If set to text the phone field must also be set and a text will be sent.	No	link, email, text	link
phone	The phone number to text the Flow link to if run_type is set to text.	No (Yes if run_type is set to text )	A valid phone number	None
email	The email address to email the Flow link to if run_type is set to email.	No (Yes if run_type is set to email )	A valid email address	None
start_session	If set to true this will initiate a Session immediately instead of requiring the link to be clicked. The link URL returned will open that Session directly.	No	true, false	false
message	If set, this will override the default message of the Flow and be displayed before the link URL.	No	Any string	The default message of the Flow.
link_life	How long a link can be clicked before expiring.	No	Any number (in seconds) or null	No expiration
session_life	How long a user has to return to a started Session before expiring. By default a Session starts when the link is clicked. However, if `start_session` is set to true, then the Session will start immediately when the link is generated and returned by the API.	No	Any number (in seconds) or null	600 seconds
query	This will be appended onto the end of the link URL. For instance if you pass in the string test=abc&test2=xyz it will be appended as: [original_link_url]?test=abc&test2=xyz .	No	Any string	None

Response parameters

Field	Description	Returned
success	Whether or not the initiation succeeded.	Always
message	"Success" or an error message if success returned false .	Always
link_request_id	The link request ID.	On success
link	The full link URL.	On success

Response example

{
    "success": true,
    "message": "Success",
    "link_request_id": "<Link request ID>",
    "link": "https://verify.is/<flowRequestID>/<linkRequestID>"
}

Next Steps

Learn how to retrieve the results of a Flow.

Ready to eliminate fraud?

Start fighting fraud now with 1,000 Free Lookups!

We're happy to answer any questions or concerns.

Chat with our fraud detection experts any day of the week.

Call us at: (800) 713-2618

Schedule a Demo Sign Up