Create a Flow
Create a new Flow.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
A list of steps. Can either be a string or an object with additional properties. Example: A redirect step looks like {"name": "redirect", "redirect_url": "https://example.com"}
compliance, id-verification, manage-payouts, manage-payments, payout, background-check, redirect The user's id. If the user's ID is provided, the flow will be created in the authenticated state with a 15 minute expiration time unless the require_auth option is set to true.
Hide the "Go to dashboard" button on the flow UI. Defaults to false.
Require the user to be authenticated to complete the flow. Defaults to false.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Response
ID of the flow.
Date that the flow was created.
ID of the user that has claimed the flow.
Array of steps in the flow.
compliance, id-verification, background-check, manage-payments, manage-payouts, payout, redirect Array of steps that have been completed in the flow.
compliance, id-verification, background-check, manage-payments, manage-payouts, payout, redirect URL to access the flow. Can be embedded in an iframe.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.