v1

latestOpenAPI 3.0.12026-07-2474233379.5 KB
Using the API

Create a new user state ID or update an existing one with some initialization data

post/init/{flowId}

Path parameters

flowIdstring required

The ID of the flow

Headers

x-hf-sessionstring

ID for a user state in the execution flow (generated in the first interaction with a flow).

When x-hf-session header is used, the provided user state will be updated.

Request body

InitData required

Example request

{
  "fieldInitDataMap": {
    "some_node_id": {
      "firstNameFieldId": "John",
      "aNumberFieldId": 123
    },
    "some_node_id2": {
      "anEmailFieldId": "some_email@trulioo.com",
      "phoneNumberFieldId": {
        "area": "+1",
        "country": "CA",
        "number": "2154567890"
      }
    }
  }
}

Response

Returns the new x-hf-session created or the same one if provided in the x-hf-session