{
  "opencollection": "1.0.0",
  "info": {
    "name": "Onfido Workflows API",
    "version": "v3.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflows",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Workflow Runs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The number of the page to be retrieved. If not specified, defaults to 1."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'."
              },
              {
                "name": "created_at_gt",
                "value": "",
                "type": "query",
                "description": "A ISO-8601 date to filter results with a created date greater than (after) the one provided."
              },
              {
                "name": "created_at_lt",
                "value": "",
                "type": "query",
                "description": "A ISO-8601 date to filter results with a created date less than (before) the one provided."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'."
              }
            ]
          },
          "docs": "Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.\n"
        },
        {
          "info": {
            "name": "Create a Workflow Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates and starts a Workflow Run. Returns a Workflow Run object.\n"
        },
        {
          "info": {
            "name": "Retrieve Workflow Run",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run."
              }
            ]
          },
          "docs": "A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n"
        },
        {
          "info": {
            "name": "Retrieve Workflow Run Evidence Summary File",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/signed_evidence_file",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "Workflow Run ID"
              }
            ]
          },
          "docs": "Retrieves the signed evidence file for the designated Workflow Run\n"
        },
        {
          "info": {
            "name": "List Tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run to which the Tasks belong."
              }
            ]
          },
          "docs": "The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n"
        },
        {
          "info": {
            "name": "Retrieve Task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks/:task_id",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run to which the Task belongs."
              },
              {
                "name": "task_id",
                "value": "",
                "type": "path",
                "description": "The identifier of the Task you want to retrieve."
              }
            ]
          },
          "docs": "A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.\n"
        },
        {
          "info": {
            "name": "Complete Task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks/:task_id/complete",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run to which the Task belongs."
              },
              {
                "name": "task_id",
                "value": "",
                "type": "path",
                "description": "The identifier of the Task you want to complete."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Completes a Send / Receive Data Task.\n"
        },
        {
          "info": {
            "name": "Create Timeline File for Workflow Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/timeline_file",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run."
              }
            ]
          },
          "docs": "Triggers the generation of the Timeline File for the designated Workflow Run.\n"
        },
        {
          "info": {
            "name": "Retrieve Timeline File for Workflow Run",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/timeline_file/:timeline_file_id",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Workflow Run."
              },
              {
                "name": "timeline_file_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the Timefile File."
              }
            ]
          },
          "docs": "Retrieves the Timeline File for the designated Workflow Run.\n"
        }
      ]
    }
  ],
  "bundled": true
}