Create a flow

Who can call it: tenant_admin, tenant_reviewer, tenant_api_manager or platform_admin. A tenant_viewer is read-only and gets 403.

Created as a draft in the sandbox. The graph is validated: 422 with the list of errors if it is not sound.

Auth: dashboard session (Authorization: Bearer <access token>). Not available with a partner API key.

Create a flow

cURL

curl --request POST \
  --url https://app.sahlfinancial.com/api/v1/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Salaried borrower",
  "use_case": "lending",
  "kind": "kyc",
  "country": "MA",
  "nodes": [
    {
      "id": "start",
      "type": "start",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "label": "Start"
      }
    },
    {
      "id": "end",
      "type": "end",
      "position": {
        "x": 240,
        "y": 0
      },
      "data": {
        "label": "End"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "start",
      "target": "end"
    }
  ]
}
'

201

{
  "id": "d6a3f9b8-2c5e-4170-b8d1-4e0a7c3f5b29",
  "tenant_id": "0b6f5a3e-7c1d-4e0a-9d2f-3a1c5e8b7f10",
  "name": "Salaried borrower",
  "description": null,
  "use_case": "lending",
  "kind": "kyc",
  "country": "MA",
  "nodes": [
    {
      "id": "start",
      "type": "start",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "label": "Start"
      }
    },
    {
      "id": "end",
      "type": "end",
      "position": {
        "x": 240,
        "y": 0
      },
      "data": {
        "label": "End"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "start",
      "target": "end"
    }
  ],
  "version": 1,
  "is_published": false,
  "status": "draft",
  "environment": "sandbox",
  "created_at": "2026-10-07T09:14:22Z",
  "updated_at": "2026-10-07T09:14:22Z",
  "published_at": null,
  "country_support": null
}

Authorizations

Authorization · string · header · required

The access token (JWT) of a signed-in console user, from POST /v1/auth/login. It lasts 30 minutes. It is not an API key: a partner API key is refused here. There is no cookie.

Body

application/json

name · string · default: Untitled Flow

Maximum string length: 255

description · string | null

use_case · string · default: loan

Maximum string length: 50

kind · enum<string> · default: kyc

Available options: kyc, kyb

country · string | null

Maximum string length: 2

nodes · object[]

Show child attributes

edges · object[]

Show child attributes

Response

201

application/json

Created

id · string<uuid> · required

tenant_id · string<uuid> · required

name · string · required

description · string | null · required

use_case · string · required

kind · enum<string> · required

Available options: kyc, kyb

nodes · object[] · required

edges · object[] · required

version · integer · required

is_published · boolean · required

status · string · required

environment · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

published_at · string<date-time> | null · required

country_support · string | null · required

"ga", "beta" (CI, SN, TN, EG, SA) or None for the flow's country.

country · string | null