Get flows

Retrieve a list of available flows configured for your environment

Use this endpoint to retrieve all flows available in your environment. The response provides essential metadata for each flow.

Endpoint

GET v1/flows/{environment}

Path parameters

Parameter	Type	Required	Description
environment	String	Yes	The logical environments ( live or staging )

Request

No request body is required for this endpoint.

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Returns an array of flow objects with minimal metadata.

{
  "content": [
    {
      "id": "0197c55f-5af6-7e3d-af9b-f2359b104be8",
      "name": "Document-based IDV - Capture",
      "description": "Verifies identity by capturing and checking official ID documents",
      "version": 1,
      "environment": "live"
    },
    {
      "id": "0197c55f-5af6-7e6g-af9b-f2359b104be8",
      "name": "Biometric authentication",
      "description": "Identity verification using unique body features instead of passwords",
      "version": 2,
      "environment": "staging"
    }
  ]
}

Response parameters

Parameter	Type	Description
content	array	Array of flow objects
id	string	Unique identifier for the flow
name	string	Configurable display name of the flow
description	string	Configurable description of the flow's purpose
version	string	Active flow version
environment	string	Active flow environment

Notes

• All flows published are returned in a single response