v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Workflow Session

Create a new Workflow Session

Creates a new Workflow Session resource.

post/workflow_sessions

Request body

workflow_template_idstring uuid required

Unique ID of the Workflow Template from which to create the new Workflow Session.

workspace_idstring uuid

Unique ID of the Workspace in which to scope the Workflow Session.

namestring safe-string required

Name given to the Workflow Session. Enter a meaningful, descriptive name to help you easily find this Workflow Session in the application.
This property is a Safe String.

Example request

{
  "workflow_template_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "workspace_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "name": "Customer onboarding of John Doe."
}

Response

Created

idstring uuid required

Unique identifier of the Workflow Session.

created_atstring date-time required

updated_atstring date-time required

namestring required

Name given to the Workflow Session. Used to easily find it in the application.

workflow_template_idstring uuid required

Unique identifier of the Workflow Template from which this Workflow Session was created.

workspace_idstring uuid required

Unique identifier of the Workspace in which this Workflow Session is scoped.

status'awaiting' | 'ongoing' | 'blocked' | 'done' required

Status of the Workflow Session.

Example response

{
  "id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z",
  "name": "Customer onboarding of John Doe",
  "workflow_template_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "workspace_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "status": "ongoing",
  "action_groups": [
    {
      "type": "identity_verification",
      "status": "ongoing",
      "actions": [
        {
          "resource": {
            "id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
            "created_at": "2025-02-12T23:59:59+00:00",
            "type": "identity_video_verification",
            "status": "verified",
            "previous_attempt_id": null
          },
          "resolution": {
            "reason": "Manual verification.",
            "resolved_at": "2024-01-18T22:59:00Z"
          },
          "previous_attempts": [
            {
              "resource": {
                "id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
                "created_at": "2025-02-12T23:59:59+00:00",
                "type": "identity_video_verification",
                "status": "verified",
                "previous_attempt_id": null
              }
            }
          ]
        }
      ]
    }
  ]
}