Exchange Flow Capability

post/v1/flow-sessions

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Request body

JSON · required

app_version

string | null

No additional field description.

channel

FlowSessionChannel

No additional field description.

device_instance_id

stringrequired

No additional field description.

entities

EvidenceEntityFragment[]

No additional field description.

link_id

stringrequired

No additional field description.

platform

FlowSessionPlatform

No additional field description.

sdk_version

string | null

No additional field description.

tenant_slug

stringrequired

No additional field description.

token

stringrequired

No additional field description.

Example request

cURL

curl --request POST \
  --url 'https://api.fideralabs.com/v1/flow-sessions' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "app_version": "string",
  "channel": "web",
  "device_instance_id": "string",
  "entities": [
    {
      "id": "string",
      "observed_at": {},
      "properties": {},
      "schema": "string"
    }
  ],
  "link_id": "00000000-0000-0000-0000-000000000000",
  "platform": "unknown",
  "sdk_version": "string",
  "tenant_slug": "string",
  "token": "string"
}'

Responses

200Successful Response

expires_at

stringrequired

No additional field description.

flow_id

stringrequired

No additional field description.

resumed

booleanrequired

No additional field description.

session_id

stringrequired

No additional field description.

session_token

string | null

Present for native channels; browser sessions use the HttpOnly cookie.

submission_id

stringrequired

No additional field description.

application/json

{
  "expires_at": "2026-07-29T12:00:00Z",
  "flow_id": "00000000-0000-0000-0000-000000000000",
  "resumed": true,
  "session_id": "00000000-0000-0000-0000-000000000000",
  "session_token": "string",
  "submission_id": "00000000-0000-0000-0000-000000000000"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

exchange_flow_capability_v1_flow_sessions_post